Docs For Class FooterNav

## Class FooterNav

Description

Use this class to render footer navigation that is displayed at the bottom of a page.

- author: Walter A. Boring IV <waboring@newsblob.com>

Located in /widgets/FooterNav.inc (line 26)

    Container
       |
       --BaseWidget
          |
          --FooterNav

Method Summary
FooterNav FooterNav ([string $company_name = ""], [string $date_str = NULL])
void add (string $url, text $text)
SPANtag build_copyright_header ()
TABLEtag build_wrapper_table ()
void push (string $url, text $text)
string render ([int $indent_level = 1], int $output_debug)
void set_company_name (string $name)
void set_copyright_flag (boolean $flag)
void set_date_string (string $date_str)
void set_legalnotice_url (string $url)
void set_privacypolicy_url (string $url)
void set_webmaster_email (string $email)
Variables

#### Inherited Variables

Inherited from BaseWidget

> BaseWidget::$title
> BaseWidget::$width
> BaseWidget::$_image_prefix

Methods
Constructor FooterNav (line 96)

Constructore for this class.

FooterNav FooterNav ([string $company_name = ""], [string $date_str = NULL])

- string $company_name: - used in the
  - copyright
- string $date_str: - a date string to be used for the copyright.

add (line 177)

add an entry to the footer nav

void add (string $url, text $text)

- string $url: - $url - url to go to
- text $text: - $text - url text to click on.

Redefinition of:

Container::add()
  add content onto content stack

build_copyright_header (line 254)

render the copyright string

- return: object that contains the copyright header.

SPANtag build_copyright_header ()
build_wrapper_table (line 283)

builds the wrapper table

- return: object.

TABLEtag build_wrapper_table ()
push (line 190)

add an entry to the footer nav.

void push (string $url, text $text)

- string $url: - $url - url to go to
- text $text: - $text - url text to click on.

Redefinition of:

Container::push()
  Same as add().

render (line 211)

render the code for this widget.

- return: the raw html output.

string render ([int $indent_level = 1], int $output_debug)

- int $indent_level: - the indentation level for the container.
- int $output_debug: - the output debug flag to maintain compatibility w/ the API.

Redefinition of:

Container::render()
  This function is compatible with the rest of the phpHtmllib API spec.

set_company_name (line 112)

set the company name for the copyright statement.

void set_company_name (string $name)

- string $name: - $name

set_copyright_flag (line 133)

set/unset the flag to tell us to render the copyright string

void set_copyright_flag (boolean $flag)

- boolean $flag: - $flag

set_date_string (line 123)

set the date string for the copyright.

in the form of "2001-1997", or "2001".

void set_date_string (string $date_str)

- string $date_str: - $date_str

set_legalnotice_url (line 144)

set the legal notice url.

if this is set we show the legal notice link that points to $url.

void set_legalnotice_url (string $url)

- string $url: - $url

set_privacypolicy_url (line 155)

sets the Privacy policy url.

if this is set we show the privacy policy link that points to $url

void set_privacypolicy_url (string $url)

- string $url: - $url

set_webmaster_email (line 166)

sets the Webmaster email address if this is set we show the mailto for this email

void set_webmaster_email (string $email)

- string $email: - $email

#### Inherited Methods

Inherited From BaseWidget

> BaseWidget::get_align()
> BaseWidget::get_css()
> BaseWidget::get_javascript()
> BaseWidget::get_title()
> BaseWidget::get_width()
> BaseWidget::set_align()
> BaseWidget::set_image_path_prefix()
> BaseWidget::set_title()
> BaseWidget::set_width()

Inherited From Container

> Container::Container()
> Container::add()
> Container::add_reference()
> Container::count_content()
> Container::get_element()
> Container::get_indent_flag()
> Container::push()
> Container::push_reference()
> Container::render()
> Container::reset_content()
> Container::set_collapse()
> Container::set_indent_flag()

Documentation generated on Thu, 1 Sep 2005 17:05:55 -0700 by phpDocumentor 1.3.0RC3