]> src.bluestatic.org Git - isso.git/blob - printer_navigation.php
No longer use underscores in the API. This is a very breaking-heavy commit.
[isso.git] / printer_navigation.php
1 <?php
2 /*=====================================================================*\
3 || ###################################################################
4 || # Blue Static ISSO Framework [#]issoversion[#]
5 || # Copyright ©2002-[#]year[#] Blue Static
6 || #
7 || # This program is free software; you can redistribute it and/or modify
8 || # it under the terms of the GNU General Public License as published by
9 || # the Free Software Foundation; version [#]gpl[#] of the License.
10 || #
11 || # This program is distributed in the hope that it will be useful, but
12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 || # more details.
15 || #
16 || # You should have received a copy of the GNU General Public License along
17 || # with this program; if not, write to the Free Software Foundation, Inc.,
18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
19 || ###################################################################
20 \*=====================================================================*/
21
22 /**
23 * Printer - Navigation Generator
24 * printer_navigation.php
25 *
26 * @package ISSO
27 */
28
29 /**
30 * Printer - Navigation Generator
31 *
32 * This framework works in conjunction with ISSO.Printer to generate a page header
33 * and sidebar to be used for navigation. You set the navigation array and then can
34 * specify a given key to highlight elements. Elements are broken into three types:
35 * tabs (top of the page), groups (blocks of link actions), and links
36 *
37 * @author Blue Static
38 * @copyright Copyright ©2002 - [#]year[#], Blue Static
39 * @version $Revision$
40 * @package ISSO
41 *
42 */
43 class Printer_Navigation
44 {
45 /**
46 * Framework registry object
47 * @var object
48 */
49 private $registry = null;
50
51 /**
52 * Global links that are used for admin home, logout, etc.
53 * @var array
54 */
55 private $toplinks = array();
56
57 /**
58 * Navigational tabs: array(text, url)
59 * @var array
60 */
61 private $tabs = array();
62
63 /**
64 * Sections: text
65 * @var array
66 */
67 private $sections = array();
68
69 /**
70 * Links: array(text, url)
71 * @var array
72 */
73 private $links = array();
74
75 /**
76 * Array of scopes to set focus to key
77 * @var array
78 */
79 private $focus = array('tab' => null, 'link' => null);
80
81 // ###################################################################
82 /**
83 * Constructor
84 */
85 public function __construct(&$registry)
86 {
87 $this->registry =& $registry;
88 }
89
90 // ###################################################################
91 /**
92 * Adds a global link to the array; these cannot be removed once added
93 *
94 * @param string Link text
95 * @param string HREF of the URL
96 */
97 public function add_top_link($text, $href)
98 {
99 $this->toplinks["$href"] = $text;
100 }
101
102 // ###################################################################
103 /**
104 * Adds to the structure array. The following is the global structure
105 * of the array, but you can specify any entry point. When you add onto
106 * the structure, it will go at the bottom
107 * array(
108 * '<tab>unique_key' => array(
109 * '<section>unique_key' => array(
110 * '<link>unique_key' => array('text', 'url')
111 * )
112 * )
113 * )
114 *
115 * Note that the portion in brackets is called the "scope"
116 *
117 * @param string Scope to add to
118 * @param string Unique key for the scope
119 * @param string Parent key to add to
120 * @param string Text to display (usually localized)
121 * @param string URL to go to when text is clicked
122 */
123 public function add_component($scope, $key, $parent, $text, $url)
124 {
125 if ($scope == 'tab')
126 {
127 $this->tabs["$key"] = array($text, $url);
128 }
129 else if ($scope == 'section')
130 {
131 $this->sections["$parent"]["$key"] = $text;
132 }
133 else if ($scope == 'link')
134 {
135 $this->links["$parent"]["$key"] = array($text, $url);
136 }
137 }
138
139 // ###################################################################
140 /**
141 * Sets the focus for either a tab or link
142 *
143 * @param string Scope operator
144 * @param string Unique key in scope
145 * @param string Parent operator (links only)
146 */
147 public function set_focus($scope, $key, $parent)
148 {
149 if ($scope == 'tab')
150 {
151 if (isset($this->tabs["$key"]))
152 {
153 $this->focus["$scope"] = $key;
154 }
155 else
156 {
157 trigger_error('Invalid key for scope', E_USER_WARNING);
158 }
159 }
160 else if ($scope == 'link')
161 {
162 if (isset($this->links["$parent"]["$key"]))
163 {
164 $this->focus["$scope"] = $key;
165 }
166 else
167 {
168 trigger_error('Invalid key for scope', E_USER_WARNING);
169 }
170 }
171 else
172 {
173 trigger_error('Printer_Navigation::set_focus() only allows setting of focus for tab and link scopes', E_USER_ERROR);
174 }
175 }
176
177 // ###################################################################
178 /**
179 * Generates the header HTML that is called in ISSO.Printer->page_start()
180 * to setup the navigation frame
181 *
182 * @return string Generated HTML content
183 */
184 public function generate_header_html()
185 {
186 $output = '<!-- navigation start -->' . "\n\n";
187
188 // -------------------------------------------------------------------
189
190 $output2 = array();
191 foreach ($this->toplinks AS $href => $text)
192 {
193 $output2[] = '<a href="' . $href . '">' . $text . '</a>';
194 }
195
196 $output .= "\n" . '<div id="toplinks">';
197 $output .= "\n\t" . '<div>' . $this->registry->get('application') . ' ' . $this->registry->modules['printer']->get('realm') . '</div>';
198 $output .= "\n\t" . '<div id="toplinks-links">' . implode(' &bull; ', $output2) . '</div>';
199 $output .= "\n" . '</div>';
200
201 // -------------------------------------------------------------------
202
203 $output .= "\n\n" . '<div id="wrapper">';
204
205 // -------------------------------------------------------------------
206
207 $output .= "\n" . '<div id="tabbar">';
208 foreach ($this->tabs AS $key => $content)
209 {
210 $link = "\n\t" . '<a href="' . $content[1] . '"';
211 if ($this->focus['tab'] == $key)
212 {
213 $link .= ' id="focustab"';
214 }
215
216 $link .= '><span>' . $content[0] . '</span></a>';
217
218 $output .= $link;
219 }
220 $output .= "\n" . '</div>';
221
222 // -------------------------------------------------------------------
223
224 $output .= "\n\n" . '<table id="contentbody" cellspacing="0" cellpadding="0" border="0">';
225 $output .= "\n" . '<tr>';
226
227 // -------------------------------------------------------------------
228
229 $output .= "\n" . '<td id="menu">';
230 foreach ((array)$this->sections[ $this->focus['tab'] ] AS $key => $text)
231 {
232 $output .= "\n" . '<ul>';
233 $output .= "\n\t" . '<li class="header"><span>' . $text . '</span></li>';
234 foreach ((array)$this->links["$key"] AS $key2 => $content)
235 {
236 $output .= "\n\t" . '<li' . ($this->focus['link'] == $key2 ? ' class="focus"' : '') . '><a href="' . $content[1] . '"><span>' . $content[0] . '</span></a></li>';
237 }
238 $output .= "\n" . '</ul>' . "\n";
239 }
240 $output .= "\n" . '</td>';
241
242 // -------------------------------------------------------------------
243
244 $output .= "\n" . '<td id="mainbody">';
245 $output .= "\n\n" . '<!-- main content body -->' . "\n";
246
247 return $output;
248 }
249
250 // ###################################################################
251 /**
252 * Generates the HTML that is inserted in ISSO.Printer->page_end() that
253 * closes all of the navigation HTML stuff
254 *
255 * @return string Generated HTML content
256 */
257 public function generate_footer_html()
258 {
259 $output = '';
260
261 $output .= "\n" . '<!-- / main content body -->' . "\n";
262
263 $output .= "\n" . '</td>';
264 $output .= "\n" . '</tr>';
265
266 $output .= "\n\n" . '</table>';
267
268 $output .= "\n\n" . '</div>';
269
270 return $output;
271 }
272 }
273
274 /*=====================================================================*\
275 || ###################################################################
276 || # $HeadURL$
277 || # $Id$
278 || ###################################################################
279 \*=====================================================================*/
280 ?>