Adding skeleton for the navigation printer
[isso.git] / printer_navigation.php
1 <?php
2 /*=====================================================================*\
3 || ###################################################################
4 || # Iris Studios Shared Object Framework [#]issoversion[#]
5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
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 Iris Studios, Inc.
38 * @copyright Copyright ©2002 - [#]year[#], Iris Studios, Inc.
39 * @version $Revision$
40 * @package ISSO
41 *
42 */
43 class Printer_Navigation
44 {
45 /**
46 * Framework registry object
47 * @var object
48 * @access private
49 */
50 var $registry = null;
51
52 // ###################################################################
53 /**
54 * Constructor
55 */
56 function __construct(&$registry)
57 {
58 $this->registry =& $registry;
59 }
60
61 // ###################################################################
62 /**
63 * (PHP 4) Constructor
64 */
65 function Printer_Navigation(&$registry)
66 {
67 $this->__construct($registry);
68 }
69
70 // ###################################################################
71 /**
72 * Generates the header HTML that is called in ISSO.Printer->page_start()
73 * to setup the navigation frame
74 *
75 * @access public
76 *
77 * @return string Generated HTML content
78 */
79 function generate_header_html()
80 {
81 return $output;
82 }
83 }
84
85 /*=====================================================================*\
86 || ###################################################################
87 || # $HeadURL$
88 || # $Id$
89 || ###################################################################
90 \*=====================================================================*/
91 ?>