menu
Packages
Interfaces
Classes
Files

Class: LinksMenu

Source Location: /menu/links/links_menu.class.php [line 47]

Class Overview

Menu
   |
   --LinksMenuElement
      |
      --LinksMenu
Create a Menu with children. Children could be Menu or LinksMenuLink objects

Author(s):



Class Details

Create a Menu with children. Children could be Menu or LinksMenuLink objects

Tags:

[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]


Class Methods

constructor LinksMenu [line 58]

LinksMenu LinksMenu( string $title, string $url, [string $image = ''], [string $type = VERTICAL_SCROLLING_MENU], int $id)
Constructor

Parameters:

string   $title   Menu title
string   $url   Destination url
string   $image   Menu's image url relative to the website root or absolute
string   $type   Menu's type
int   $id   The Menu's id in the database
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method add [line 81]

void add( LinksMenuElement $element)
Add a single LinksMenuLink or (sub) Menu

Parameters:

LinksMenuElement   $element   the LinksMenuLink or Menu to add
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method add_array [line 71]

void add_array( &LinksMenuElement[] &$menu_elements)
Add a list of LinksMenu or (sub)Menu to the current one

Parameters:

&LinksMenuElement[]   &$menu_elements   A reference to a list of LinksMenuLink and / or Menu to add
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method cache_export [line 147]

string cache_export( [ $template = false])

Tags:

  • return: the string to write in the cache file
Overrides LinksMenuElement::cache_export() (returns the string to write in the cache file)

Parameters:

   $template  
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method display [line 106]

string display( [Template $template = false], [ $mode = LINKS_MENU_ELEMENT__CLASSIC_DISPLAYING])
Display the menu

Tags:

  • return: the menu parsed in xHTML
Overrides LinksMenuElement::display() (Displays the menu according to the given template)

Parameters:

Template   $template   the template to use
   $mode  
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method get_children [line 209]

LinksMenuElement[] get_children( )

Tags:

  • return: the menu children elements
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method get_type [line 197]

string get_type( )

Tags:

  • return: the menu type
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method set_type [line 204]

void set_type( string $type)
Sets the type of the menu

Sets the type of the menu

Parameters:

string   $type   Type of the menu
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method update_uid [line 94]

void update_uid( )
Update the menu uid

Update the menu uid

Overrides LinksMenuElement::update_uid() (Update the menu uid)
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method _parent [line 228]

void _parent( string $type)
Increase the Menu Depth and set the menu type to its parent one

Tags:

  • access: protected
Overrides LinksMenuElement::_parent() (Increase the Menu Depth and set the menu type to its parent one)

Parameters:

string   $type   the type of the menu
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

static method get_menu_types_list [line 217]

static string[] get_menu_types_list( )
static method which returns all the menu types

static method which returns all the menu types

Tags:

  • return: The list of the menu types
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]


Class Variables

[line 249]   LinksMenuElement[]  $elements  = array()

Tags:

  • access: protected
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
[line 244]   string  $type 

Tags:

  • access: protected
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

Inherited Methods

Class: LinksMenuElement

LinksMenuElement::LinksMenuElement()
Build a LinksMenuElement object
LinksMenuElement::cache_export()
returns the string to write in the cache file
LinksMenuElement::cache_export_begin()
returns the string to write in the cache file at the beginning of the Menu element
LinksMenuElement::cache_export_end()
returns the string to write in the cache file at the end of the Menu element
LinksMenuElement::display()
Displays the menu according to the given template
LinksMenuElement::get_image()
LinksMenuElement::get_uid()
Returns the menu uid
LinksMenuElement::get_url()
LinksMenuElement::set_image()
LinksMenuElement::set_url()
LinksMenuElement::update_uid()
Update the menu uid
LinksMenuElement::_assign()
Assign tpl vars
LinksMenuElement::_parent()
Increase the Menu Depth and set the menu type to its parent one

Class: Menu

Menu::Menu()
Build a Menu element.
Menu::admin_display()
Display the menu admin gui
Menu::cache_export()
Menu::cache_export_begin()
Menu::cache_export_end()
Menu::display()
Display the menu
Menu::enabled()
Menu::get_auth()
Menu::get_block()
Menu::get_block_position()
Menu::get_id()
Menu::get_title()
Menu::id()
Menu::is_enabled()
Menu::set_auth()
Menu::set_block()
Menu::set_block_position()
Menu::set_title()
Menu::_assign()
Assign tpl vars


Documentation generated on Tue, 28 Jul 2009 22:43:39 +0200 by phpDocumentor 1.4.1