Class: WebsiteNavigation

Source Location: /html/components/WebsiteNavigation.class.php

Class Overview

ABSTObject
   |
   --ABSTHTMLTag
      |
      --HTMLList
         |
         --WebsiteNavigation

A class to generate the navigation of a website.

Author(s):

Daniel Plücken <daniel@debakel.net>

Version:

0.1.41

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

Variables

Methods

Child classes:

AlphabetFilter: A class to generate a albabethical list to use as Filter for several data.

Inherited Variables

Class: HTMLList

HTMLList::$freestyle_arr
HTMLList::$kind
HTMLList::$list_arr
HTMLList::$mouseout_arr
HTMLList::$mouseover_arr
HTMLList::$mouseup_arr
HTMLList::$style_class_arr

Class: ABSTHTMLTag

ABSTHTMLTag::$blur
ABSTHTMLTag::$click
ABSTHTMLTag::$focus
ABSTHTMLTag::$freestyle
ABSTHTMLTag::$id
ABSTHTMLTag::$mousemove
ABSTHTMLTag::$mouseout
ABSTHTMLTag::$mouseover
ABSTHTMLTag::$mouseup
ABSTHTMLTag::$name
ABSTHTMLTag::$no_format
ABSTHTMLTag::$other_attributes
ABSTHTMLTag::$style_class

Inherited Methods

Class: HTMLList

HTMLList::HTMLList(): Constructor.
HTMLList::addElement(): Adds an element to the list.
HTMLList::deleteElementAt(): Removes the element at $int-index. All elements behind the deleted element moving up by one position.
HTMLList::get(): Returns a generated string based on the attributes of this HTML-Object.
HTMLList::setKind(): Sets the the kind of this list ("ul" or "ol").

Class: ABSTHTMLTag

ABSTHTMLTag::getId(): Returns the value of this tag's "id"-attribute.
ABSTHTMLTag::getName(): Returns the value of this tag's "name"-attribute.
ABSTHTMLTag::HTMLTag(): The Constructor let the script die, cause this is an abstract class!
ABSTHTMLTag::idExists(): Stores all used ids and makes sure that every id in the document is unique. It should called in every get method of classes in the packages forms and html.
ABSTHTMLTag::setAttributes(): This method allows to set the attributes of the tag that are not handled by other methods.
ABSTHTMLTag::setFreeStyle(): Set the value of style definitions that are not handled by implemented methods.
ABSTHTMLTag::setId(): Stores the value of this item's "id"-attribute.
ABSTHTMLTag::setName(): Stores the value of this tag's "name"-attribute.
ABSTHTMLTag::setNoFormat(): Stores that the HTML-elements should not format by "\r\n" in the source.
ABSTHTMLTag::setOnBlur(): Sets the value of the blur-attribute of this html-tag.
ABSTHTMLTag::setOnClick(): Sets the value of the click-attribute of this html-tag.
ABSTHTMLTag::setOnFocus(): Sets the value of the focus-attribute of this html-tag.
ABSTHTMLTag::setOnMouseMove(): Sets the value of the mousemove-attribute of this html-tag.
ABSTHTMLTag::setOnMouseOut(): Sets the value of the mouseout-attribute of this html-tag.
ABSTHTMLTag::setOnMouseOver(): Sets the value of the mouseover-attribute of this html-tag.
ABSTHTMLTag::setOnMouseUp(): Sets the value of the mouseup-attribute of this html-tag.
ABSTHTMLTag::setStyle(): Set the value of the class-attribute of this tag.

Class: ABSTObject

ABSTObject::printComplexData(): Prints out the more complex data by the given array.
ABSTObject::printPrimitiveData(): Prints out the primitive data by the given arrays.
ABSTObject::printStructure(): Prints out the Structure of this Object.
ABSTObject::same(): Checks whether the passed object reference points to this object.
ABSTObject::sameReferences(): Compares two references whether they points to the same object

Class Details

[line 55]
A class to generate the navigation of a website.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	0.1.41
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
since:	0.9.1.5
license:	GNU Lesser General Public License

[ Top ]

Class Variables

$str_style_on_mouseover_arr = array()

[line 66]

Tags:

access:

public

Type:

array

[ Top ]

$str_style_on_mouseup_arr = array()

[line 61]

Tags:

access:

public

Type:

array

[ Top ]

$str_value_arr = array()

[line 71]

Tags:

access:

public

Type:

array

[ Top ]

Class Methods

constructor WebsiteNavigation [line 95]

WebsiteNavigation WebsiteNavigation(
[array
$label_arr = array()], [array
$href_arr = array()], [array
$value_arr = array()], [array
$style_class_arr = array()], [array
$link_style_class_arr = array()], [array
$freestyle_arr = array()], [array
$link_freestyle_arr = array()], [array
$target_arr = array()])

Constructor.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.1
since:	0.1.1
access:	public

Parameters:

array	$label_arr
array	$href_arr	Use the placeholder [value] to place the the corresponding value from the array $value_arr
array	$value_arr
array	$style_class_arr
array	$link_style_class_arr
array	$freestyle_arr
array	$link_freestyle_arr
array	$target_arr

[ Top ]

method addElement [line 246]

integer addElement(
string
$str_label, string
$str_href, string
$str_value, [string
$str_style_class = ""], [string
$str_link_style_class = ""], [string
$str_freestyle = ""], [string
$str_link_freestyle = ""], [string
$str_target = ""])

Adds a navigation point to the list.

Tags:

return:	The insert position.
author:	Daniel Plücken <daniel@debakel.net>
version:	1.3
since:	0.1.0
access:	public

Overrides HTMLList::addElement() (Adds an element to the list.)

Parameters:

string	$str_label
string	$str_href	Use the placeholder [value] to place the the corresponding value.
string	$str_value
string	$str_style_class
string	$str_link_style_class
string	$str_freestyle
string	$str_link_freestyle
string	$str_target

[ Top ]

method deleteElementAt [line 291]

void deleteElementAt(

&$int, integer
$int)

Removes the element at $int-index. All elements behind the deleted element moving up by one position.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.11
since:	0.1.0
access:	public

Overrides HTMLList::deleteElementAt() (Removes the element at $int-index. All elements behind the deleted element moving up by one position.)

Parameters:

integer	$int	Index of the element to remove.
	&$int

[ Top ]

method get [line 311]

string get(
)

Returns a generated string based on the attributes of this HTML-Object.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.2
since:	0.1.0
access:	public

Overridden in child classes as:

AlphabetFilter::get(): Returns a generated string based on the attributes of this HTML-Object.

Overrides HTMLList::get() (Returns a generated string based on the attributes of this HTML-Object.)

[ Top ]

method setMarkedValue [line 172]

void setMarkedValue(
string
$str_value, [string
$str_style_class = ""], [string
$str_link_style_class = ""], [string
$str_freestyle = ""], [string
$str_link_freestyle = ""])

Sets the style of the a list item identified by his given value.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.1.2
access:	public

Overridden in child classes as:

AlphabetFilter::setMarkedValue(): Sets the style of the a list item identified by his given value.

Parameters:

string	$str_value
string	$str_style_class
string	$str_link_style_class
string	$str_freestyle
string	$str_link_freestyle

[ Top ]

method setSelectedValue [line 209]

void setSelectedValue(
string
$str_value, [string
$str_style_class = ""], [string
$str_link_style_class = ""], [string
$str_freestyle = ""], [string
$str_link_freestyle = ""])

Sets the style of the a list item identified by his given value. This function is an alias for the function setMarkedValue.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.1.3
access:	public

Parameters:

string	$str_value
string	$str_style_class
string	$str_link_style_class
string	$str_freestyle
string	$str_link_freestyle

[ Top ]

method setStyleOnMouseOver [line 150]

void setStyleOnMouseOver(
string
$str_style_class)

Sets the style that should be used on mouseover for each element.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.1.0
access:	public

Parameters:

string

$str_style_class

[ Top ]

method setStyleOnMouseUp [line 132]

void setStyleOnMouseUp(
string
$str_style_class)

Sets the style that should be used on mouseup for each element.

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	1.0
since:	0.1.0
access:	public

Parameters:

string

$str_style_class

[ Top ]

Documentation generated on Thu, 05 Jun 2008 19:15:41 +0200 by phpDocumentor 1.4.1