<?php
/*=====================================================================*\
|| ###################################################################
|| # Iris Studios Shared Object Framework [#]issoversion[#]
|| # Copyright Š2002-[#]year[#] Iris Studios, Inc.
|| #
|| # This program is free software; you can redistribute it and/or modify
|| # it under the terms of the GNU General Public License as published by
|| # the Free Software Foundation; version [#]gpl[#] of the License.
|| #
|| # This program is distributed in the hope that it will be useful, but
|| # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|| # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|| # more details.
|| #
|| # You should have received a copy of the GNU General Public License along
|| # with this program; if not, write to the Free Software Foundation, Inc.,
|| # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|| ###################################################################
\*=====================================================================*/

/**
* Printer - Navigation Generator
* printer_navigation.php
*
* @package	ISSO
*/

/**
* Printer - Navigation Generator
*
* This framework works in conjunction with ISSO.Printer to generate a page header
* and sidebar to be used for navigation. You set the navigation array and then can
* specify a given key to highlight elements. Elements are broken into three types:
* tabs (top of the page), groups (blocks of link actions), and links
*
* @author		Iris Studios, Inc.
* @copyright	Copyright Š2002 - [#]year[#], Iris Studios, Inc.
* @version		$Revision$
* @package		ISSO
* 
*/
class Printer_Navigation
{
	/**
	* Framework registry object
	* @var	object
	* @access	private
	*/
	var $registry = null;
	
	/**
	* Global links that are used for admin home, logout, etc.
	* @var	array
	* @access	private
	*/
	var $toplinks = array();
	
	/**
	* Navigational tabs: array(text, url)
	* @var	array
	* @access	private
	*/
	var $tabs = array();
	
	/**
	* Sections: text
	* @var	array
	* @access	private
	*/
	var $sections = array();
	
	/**
	* Links: array(text, url)
	* @var	array
	* @access	private
	*/
	var $links = array();
	
	// ###################################################################
	/**
	* Constructor
	*/
	function __construct(&$registry)
	{
		$this->registry =& $registry;
	}
	
	// ###################################################################
	/**
	* (PHP 4) Constructor
	*/
	function Printer_Navigation(&$registry)
	{
		$this->__construct($registry);
	}
	
	// ###################################################################
	/**
	* Adds a global link to the array; these cannot be removed once added
	*
	* @access	public
	*
	* @param	string	Link text
	* @param	string	HREF of the URL
	*/
	function add_top_link($text, $href)
	{
		$this->toplinks["$href"] = $text;
	}
	
	// ###################################################################
	/**
	* Adds to the structure array. The following is the global structure 
	* of the array, but you can specify any entry point. When you add onto
	* the structure, it will go at the bottom
	* array(
	*	'<tab_>unique_key'	=> array(
	*		'<section_>unique_key'	=> array(
	*			'<link_>unique_key'	=> array('text', 'url')
	*		)
	*	)
	* )
	*
	* Note that the portion in brackets is automatically added to the key
	* when using the set_focus() method and is called the "scope"
	*
	* @access	public
	*
	* @param	string	Scope to add to
	* @param	string	Unique key for the scope
	* @param	string	Parent key to add to
	* @param	string	Text to display (usually localized)
	* @param	string	URL to go to when text is clicked
	*/
	function add_component($scope, $key, $parent, $text, $url)
	{
		if ($scope == 'tab')
		{
			$this->tabs["$key"] = array($text, $url);
		}
		else if ($scope == 'section')
		{
			$this->sections["$parent"]["$key"] = $text;
		}
		else if ($scope == 'link')
		{
			$this->links["$parent"]["$key"] = array($text, $url);
		}
	}
	
	// ###################################################################
	/**
	* Generates the header HTML that is called in ISSO.Printer->page_start()
	* to setup the navigation frame
	*
	* @access	public
	*
	* @return	string	Generated HTML content
	*/
	function generate_header_html()
	{
		$output = '<!-- navigation start -->' . "\n\n";
		
		$output2 = array();
		foreach ($this->toplinks AS $href => $text)
		{
			$output2[] = '<a href="' . $href . '" class="nav_toplink">' . $text . '</a>';
		}
		
		$output .= implode(' &bull; ', $output2);
		
		return $output;
	}
}

/*=====================================================================*\
|| ###################################################################
|| # $HeadURL$
|| # $Id$
|| ###################################################################
\*=====================================================================*/
?>