Class FeedMenu

__construct()

__construct(string $title,  $module_id,  $category,  $name = \Feed::DEFAULT_FEED_NAME,  $number = 10,  $begin_at) 

Build a Menu element.

Parameters

string	$title	the Menu title
	$module_id
	$category
	$name
	$number
	$begin_at

• Inherited from \FeedMenu

Tags

None found

need_cached_string()

need_cached_string() : boolean

Check if the menu needs to be cached

Returns

boolean —

true if the menu need to be cached

• Inherited from \Menu

Tags

None found

display()

display() : string

Display the menu

Returns

string —

the menu parsed in xHTML

• Inherited from \FeedMenu

Tags

None found

admin_display()

admin_display() : string

Display the menu admin gui

Returns

string —

the menu parsed in xHTML

• Inherited from \Menu

Tags

None found

id()

id(integer $id) 

Parameters

integer

$id

Set the Menu database id

• Inherited from \Menu

Tags

None found

check_auth()

check_auth() : boolean

Check the user authorization to see the LinksMenuElement

Returns

boolean —

true if the user is authorised, false otherwise

• Inherited from \Menu

Tags

None found

set_title()

set_title( $title) 

Parameters

$title

• Inherited from \Menu

Tags

None found

set_auth()

set_auth( $auth) 

Parameters

$auth

• Inherited from \Menu

Tags

None found

enabled()

enabled(boolean $enabled = self::MENU_ENABLED) 

Parameters

boolean

$enabled

Enable or not the Menu

• Inherited from \Menu

Tags

None found

set_block()

set_block( $block) : integer

Parameters

$block

Returns

integer —

the Menu $block position

• Inherited from \Menu

Tags

None found

set_block_position()

set_block_position(integer $position) 

Parameters

integer

$position

the Menu position to set

• Inherited from \Menu

Tags

None found

set_hidden_with_small_screens()

set_hidden_with_small_screens( $value) 

Parameters

$value

• Inherited from \Menu

Tags

None found

set_disabled_body()

set_disabled_body( $value) 

Parameters

$value

• Inherited from \Menu

Tags

None found

set_pushed_content()

set_pushed_content( $value) 

Parameters

$value

• Inherited from \Menu

Tags

None found

set_pushmenu_opening()

set_pushmenu_opening( $value) 

Parameters

$value

• Inherited from \Menu

Tags

None found

set_pushmenu_expanding()

set_pushmenu_expanding( $value) 

Parameters

$value

• Inherited from \Menu

Tags

None found

get_formated_title()

get_formated_title() : string

Returns

string —

the displayable Menu $title

• Inherited from \Menu

Tags

None found

get_title()

get_title() : string

Returns

string —

the Menu $title

• Inherited from \Menu

Tags

None found

get_auth()

get_auth() : array

Returns

array —

the authorization array $auth

• Inherited from \Menu

Tags

None found

get_id()

get_id() : integer

Returns

integer —

the $id of the menu in the database

• Inherited from \Menu

Tags

None found

get_block()

get_block() : integer

Returns

integer —

the Menu $block position

• Inherited from \Menu

Tags

None found

get_block_position()

get_block_position() : integer

Returns

integer —

the Menu $position

• Inherited from \Menu

Tags

None found

is_enabled()

is_enabled() : boolean

Returns

boolean —

true if the Menu is enabled, false otherwise

• Inherited from \Menu

Tags

None found

is_hidden_with_small_screens()

is_hidden_with_small_screens() : boolean

Returns

boolean —

check if menu is hidden with small screens

• Inherited from \Menu

Tags

None found

is_disabled_body()

is_disabled_body() : boolean

Returns

boolean —

check if body is disabled (pushmenu)

• Inherited from \Menu

Tags

None found

is_pushed_content()

is_pushed_content() : boolean

Returns

boolean —

check if body is pushed (pushmenu)

• Inherited from \Menu

Tags

None found

get_pushmenu_opening()

get_pushmenu_opening() : string

Returns

string —

the opening of the pushmenu

• Inherited from \Menu

Tags

None found

get_pushmenu_expanding()

get_pushmenu_expanding() : string

Returns

string —

the expanding of the pushmenu

• Inherited from \Menu

Tags

None found

get_filters()

get_filters() : string

Returns

string —

the menu filters

• Inherited from \Menu

Tags

None found

set_filters()

set_filters(\Array<Filter> $filters) 

Sets the filters of the menu

Parameters

\Array

$filters

Filters of the menu

• Inherited from \Menu

Tags

None found

set_template()

set_template(\Template $template) 

Sets the template of the menu

Parameters

\Template

$template

Template of the menu

• Inherited from \Menu

Tags

None found

get_template()

get_template(string $id, string $name = '', string $block_position = \Menu::BLOCK_POSITION__LEFT,  $hidden_with_small_screens = false,  $module_id = '') : \the

Returns the tpl to parse a feed

Parameters

string	$id	The feed id
string	$name	The feed name
string	$block_position	The indentifier block position defined in the inherit class menu
	$hidden_with_small_screens
	$module_id

Returns

\the —

tpl to parse a feed

static

• Inherited from \FeedMenu

Tags

static

get_module_id()

get_module_id() : string

Returns

string —

the feed menu module id

• Inherited from \FeedMenu

Tags

None found

get_url()

get_url(boolean $relative = false) : \Return

Parameters

boolean

$relative

If false, compute the absolute url, else, returns the relative one

Returns

\Return —

the absolute feed Url

• Inherited from \FeedMenu

Tags

None found

set_module_id()

set_module_id(string $value) 

Parameters

string

$value

the feed's module_id

• Inherited from \FeedMenu

Tags

None found

set_cat()

set_cat(integer $value) 

Parameters

integer

$value

the feed's category

• Inherited from \FeedMenu

Tags

None found

set_name()

set_name(string $value) 

Parameters

string

$value

the feed's name

• Inherited from \FeedMenu

Tags

None found

get_number()

get_number() : \Return

Returns

\Return —

the number of elements displayed in the menu

• Inherited from \FeedMenu

Tags

None found

set_number()

set_number(string $value) 

Parameters

string

$value

the number of elements displayed in the menu

• Inherited from \FeedMenu

Tags

None found

_assign()

_assign(\Template $template) 

Assign tpl vars

Parameters

\Template

$template

the template on which we gonna assign vars

• Inherited from \Menu

Tags

None found

assign_common_template_variables()

assign_common_template_variables(\Template $template) 

Assign default tpl vars

Parameters

\Template

$template

the template on which we gonna assign vars

• Inherited from \Menu

Tags

None found

get_template_to_use()

get_template_to_use() : \Template

Returns

\Template

• Inherited from \Menu

Tags

None found

get_default_template()

get_default_template() : string

Get the default template of the menu

Returns

string —

the default template of the menu

• Inherited from \Menu

Tags

None found