menu
Packages
Interfaces
Classes
Files

Class: FeedMenu

Source Location: /menu/feed/feed_menu.class.php [line 39]

Class Overview

Menu
   |
   --FeedMenu

Author(s):



Class Details

Tags:

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


Class Methods

constructor FeedMenu [line 42]

FeedMenu FeedMenu( $title, $module_id, [ $category = 0], [ $name = DEFAULT_FEED_NAME], [ $number = 10], [ $begin_at = 0])

Parameters:

   $title  
   $module_id  
   $category  
   $name  
   $number  
   $begin_at  
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method cache_export [line 95]

void cache_export( )
Overrides Menu::cache_export() (parent method not documented)
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method display [line 88]

void display( )
Overrides Menu::display() (Display the menu)
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method get_module_id [line 56]

string get_module_id( )

Tags:

  • return: the feed menu module id
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method get_url [line 62]

Return get_url( [bool $relative = false])

Tags:

  • return: the absolute feed Url

Parameters:

bool   $relative   If false, compute the absolute url, else, returns the relative one
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method set_cat [line 82]

void set_cat( int $value)

Parameters:

int   $value   the feed's category
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method set_module_id [line 78]

void set_module_id( string $value)

Parameters:

string   $value   the feed's module_id
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

method set_name [line 86]

void set_name( string $value)

Parameters:

string   $value   the feed's name
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]

static method get_template [line 111]

static the get_template( [string $name = ''], [string $block_position = BLOCK_POSITION__LEFT])
Returns the tpl to parse a feed

Tags:

  • return: tpl to parse a feed

Parameters:

string   $name   The feed name
string   $block_position   The indentifier block position defined in the inherit class menu
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]


Class Variables

[line 134]   mixed  $begin_at  =  0
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
[line 132]   mixed  $category  =  0
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
[line 130]   mixed  $module_id  =  ''
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
[line 131]   mixed  $name  =  ''
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
[line 133]   mixed  $number  =  10
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
[line 129]   string  $url  =  ''

Tags:

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

    Inherited Methods

    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:37 +0200 by phpDocumentor 1.4.1