File Source for WebsiteNavigation.class.php

<?php
/**
* For including this file you have to define the constant "CLASSPATH".
* Because every include in the framework depends on the CLASSPATH definition.
* The CLASSPATH means the relative path to the folder that contains the
* framework GilliGan.
*
* @package html
* @subpackage components
*/
if( !defined( "CLASSPATH" ) )
{
echo "<h3>You have to define the constant CLASSPATH!</h3>\n";
echo "Example: define( 'CLASSPATH', '../path/to/classes/' );\n";
exit();
}
/**
* Including the list class.
*/
require_once CLASSPATH."html/HTMLList.class.php";
/**
* Including the link class.
*/
include_once CLASSPATH."html/HTMLLink.class.php";
/**
* A class to generate the navigation of a website.
*
* @package html
* @subpackage components
* @version 0.1.41
* @since 0.9.1.5
* @author Daniel Plücken <daniel@debakel.net>
* @license http://www.gnu.org/copyleft/lesser.html
* GNU Lesser General Public License
* @copyright Copyright (c) 2006 Daniel Plücken <daniel@debakel.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License.
*
* This library 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307 USA
*/
class WebsiteNavigation extends HTMLList
{
/**
* @access public
* @var array $str_style_on_mouseup_arr
*/
var $str_style_on_mouseup_arr = array();
/**
* @access public
* @var array $str_style_on_mouseover_arr
*/
var $str_style_on_mouseover_arr = array();
/**
* @access public
* @var array $str_value_arr
*/
var $str_value_arr = array();
/**
* Constructor.
*
* @version 1.1
* @since 0.1.1
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param array $label_arr
* @param array $href_arr Use the placeholder [value] to place
* the the corresponding value from the
* array $value_arr
* @param array $value_arr
* @param array $style_class_arr
* @param array $link_style_class_arr
* @param array $freestyle_arr
* @param array $link_freestyle_arr
* @param array $target_arr
* @return WebsiteNavigation
*/
function WebsiteNavigation(
$label_arr = array(),
$href_arr = array(),
$value_arr = array(),
$style_class_arr = array(),
$link_style_class_arr = array(),
$freestyle_arr = array(),
$link_freestyle_arr = array(),
$target_arr = array()
)
{
if ( is_array( $label_arr ) )
foreach ( $label_arr as $key => $value )
$this->addElement(
$label_arr[$key],
$href_arr[$key],
$value_arr[$key],
$style_class_arr[$key],
$link_style_class_arr[$key],
$freestyle_arr[$key],
$link_freestyle_arr[$key],
$target_arr[$key]
);
}
/**
* Sets the style that should be used on mouseup for each element.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $str_style_class
* @return void
*/
function setStyleOnMouseUp( $str_style_class )
{
foreach ( $this->list_arr as $key => $value )
$this->str_style_on_mouseup_arr[$key] = $str_style_class;
}
/**
* Sets the style that should be used on mouseover for each element.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $str_style_class
* @return void
*/
function setStyleOnMouseOver( $str_style_class )
{
foreach ( $this->list_arr as $key => $value )
$this->str_style_on_mouseover_arr[$key] = $str_style_class;
}
/**
* Sets the style of the a list item identified by his given value.
*
* @version 1.0
* @since 0.1.2
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $str_value
* @param string $str_style_class
* @param string $str_link_style_class
* @param string $str_freestyle
* @param string $str_link_freestyle
* @return void
*/
function setMarkedValue(
$str_value,
$str_style_class = "",
$str_link_style_class = "",
$str_freestyle = "",
$str_link_freestyle = ""
)
{
foreach ( $this->list_arr as $key => $value )
if ( $this->str_value_arr[$key] == $str_value )
{
$this->style_class_arr[$key] = $str_style_class;
$this->freestyle_arr[$key] = $str_freestyle;
$this->list_arr[$key]->setStyle( $str_link_style_class );
$this->list_arr[$key]->setFreeStyle( $str_link_freestyle );
return;
}
}
/**
* Sets the style of the a list item identified by his given value. This
* function is an alias for the function setMarkedValue.
*
* @version 1.0
* @since 0.1.3
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $str_value
* @param string $str_style_class
* @param string $str_link_style_class
* @param string $str_freestyle
* @param string $str_link_freestyle
* @return void
*/
function setSelectedValue(
$str_value,
$str_style_class = "",
$str_link_style_class = "",
$str_freestyle = "",
$str_link_freestyle = ""
)
{
$this->setMarkedValue(
$str_value,
$str_style_class,
$str_link_style_class,
$str_freestyle,
$str_link_freestyle
);
}
/**
* Adds a navigation point to the list.
*
* @version 1.3
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $str_label
* @param string $str_href Use the placeholder [value] to
* place the the corresponding value.
* @param string $str_value
* @param string $str_style_class
* @param string $str_link_style_class
* @param string $str_freestyle
* @param string $str_link_freestyle
* @param string $str_target
* @return integer The insert position.
*/
function addElement(
$str_label,
$str_href,
$str_value,
$str_style_class = "",
$str_link_style_class = "",
$str_freestyle = "",
$str_link_freestyle = "",
$str_target = ""
)
{
$tmp_a_obj =& new HTMLLink(
$str_href,
$str_label,
$str_link_style_class
);
$tmp_a_obj->setFreeStyle( $str_link_freestyle );
$this->str_value_arr[] = $str_value;
return parent::addElement(
$tmp_a_obj,
$str_style_class,
$str_freestyle,
(
preg_match( "!^javascript:!i", $str_href )
? preg_replace( "!^javascript:!i", "", $str_href )
: ""
)
);
}
/**
* Removes the element at $int-index. All elements behind the deleted element
* moving up by one position.
*
* @version 1.11
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param integer $int Index of the element to remove.
* @return void
*/
function deleteElementAt( &$int )
{
parent::deleteElementAt( $int );
array_splice( $this->str_style_on_mouseup_arr, $int, 1 );
array_splice( $this->str_style_on_mouseover_arr, $int, 1 );
array_splice( $this->str_value_arr, $int, 1 );
}
/**
* Returns a generated string based on the attributes of this HTML-Object.
*
* @version 1.2
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @return string
*/
function get()
{
foreach ( $this->str_style_on_mouseup_arr as $key => $value )
{
if ( !preg_match( "!;$!", $this->mouseup_arr[$key] ) )
$this->mouseup_arr[$key] .= ";";
$this->mouseup_arr[$key] .= "this.className='".$value."'";
}
foreach ( $this->str_style_on_mouseover_arr as $key => $value )
{
if ( !preg_match( "!;$!", $this->mouseover_arr[$key] ) )
$this->mouseover_arr[$key] .= ";";
$this->mouseover_arr[$key] .= "this.className='".$value."'";
}
for ( $i = 0; $i < count( $this->list_arr ); $i++ )
$this->list_arr[$i]->href = preg_replace(
"!\[value\]!i",
rawurlencode( $this->str_value_arr[$i] ),
$this->list_arr[$i]->href
);
foreach ( $this->str_style_on_mouseover_arr as $key => $value )
if ( $this->str_value_arr[$key] == $this->str_selected_value )
$style_class_arr[$key] = $this->str_selected_style;
return parent::get();
}
} // End of class WebsiteNavigation
?>

Source for file WebsiteNavigation.class.php