Class

LinksMenuElement

Abstract Package: PHPBoost\Menu\links Copyright: © 2005-2019 PHPBoost License: GNU/GPL-3.0 Author: Regis VIARRE crowkait@phpboost.com Version: PHPBoost 5.2 - last update: 2016 10 24 Since: PHPBoost 2.0 - 2008 07 08 Contributor: Loic ROUCHON horn@phpboost.com Contributor: Julien BRISWALTER j1.seth@phpboost.com Contributor: Arnaud GENET elenwii@phpboost.com Located at: phpboost/menu/links/LinksMenuElement.class.php

A LinksMenuElement contains a Title, an url, and an image url

Abstract class : Do not instanciate it LinksMenuLink and LinksMenuLink classes are based on this class use, on of these
Menu
Extended by LinksMenuElement
Direct known subclasses
LinksMenu, LinksMenuLink
Methods summary
public
# __construct( $title, $url, $image = '', integer $id,… )

Build a LinksMenuElement object
protected
# _assign( Template $template, integer $mode = self::LINKS_MENU_ELEMENT__CLASSIC_DISPLAYING )

Assign tpl vars
protected
# _parent( $type )

Increase the Menu Depth and set the menu type to its parent one
public
# set_image( string $image )
public
# set_url( string $url )
public integer
# get_uid( )

Returns the menu uid
public
# update_uid( )

Update the menu uid
public string
# get_url( boolean $compute_relative_url = true )
public string
# get_image( boolean $compute_relative_url = true )
Methods inherited from Menu
admin_display(), assign_common_template_variables(), check_auth(), display(), enabled(), get_auth(), get_block(), get_block_position(), get_default_template(), get_filters(), get_formated_title(), get_id(), get_template_to_use(), get_title(), id(), is_enabled(), is_hidden_with_small_screens(), need_cached_string(), set_auth(), set_block(), set_block_position(), set_filters(), set_hidden_with_small_screens(), set_template(), set_title()
Constants summary
string LINKS_MENU_ELEMENT__CLASS
# 'LinksMenuElement'
boolean LINKS_MENU_ELEMENT__FULL_DISPLAYING
# true
boolean LINKS_MENU_ELEMENT__CLASSIC_DISPLAYING
# false
Constants inherited from Menu
BLOCK_POSITION__ALL, BLOCK_POSITION__BOTTOM_CENTRAL, BLOCK_POSITION__FOOTER, BLOCK_POSITION__HEADER, BLOCK_POSITION__LEFT, BLOCK_POSITION__NOT_ENABLED, BLOCK_POSITION__RIGHT, BLOCK_POSITION__SUB_HEADER, BLOCK_POSITION__TOP_CENTRAL, BLOCK_POSITION__TOP_FOOTER, MENU_AUTH_BIT, MENU_ENABLED, MENU_ENABLE_OR_NOT, MENU_NOT_ENABLED, MENU__CLASS
Properties summary
public string $url

the LinksMenuElement url
# ''
public string $image

the image url. Could be relative to the website root or absolute
# ''
public integer $uid

Menu's uid
# null
public integer $depth

Menu's depth
# 0
Properties inherited from Menu
$auth, $block, $enabled, $filters, $hidden_with_small_screens, $id, $position, $template, $title