Submenu widget - embed any menu on any page in any position. More...

Inheritance diagram for YAWK\WIDGETS\SUBMENU\EMBED\submenu:

Public Member Functions
	__construct ($db)
	Load all widget settings from database and fill object. More...

	displaySubMenu ($db, $menuID)
	display any subMenu (used by widgets to get any menu in any position) More...

	drawMenu ($db)

	drawSidebarEnd ()
	draw sidebar end More...

	drawSidebarStart ()
	draw sidebar start More...

	init ($db)
	Init submenu widget and call a function for demo purpose. More...

Public Member Functions inherited from YAWK\widget
	getHeading ($heading, $subtext)
	Get widget heading and subtext, return headline. More...

	getWidgetSettingsArray ($db)
	Get widget settings and return it as array. More...

	printObject ()
	Print all object data. More...

Public Attributes
string int	$menuID = ''

bool	$showMenuName = false

string	$sidebar = 'false'

string	$subMenuClass

string	$submenuHeading = ''

string	$subMenuItemClass

string	$submenuSubtext = ''

	$widget = ''

Public Attributes inherited from YAWK\widget
	$data

	$date_publish

	$date_unpublish

	$folder

	$id

	$marginBottom

	$marginTop

	$name

	$pageID

	$position

	$published

	$sort

	$widgetTitle

	$widgetType

Additional Inherited Members
Static Public Member Functions inherited from YAWK\widget
static	getAllSettingsIntoArray ($db, $widgetID)
	Returns an array with all widget settings data. More...

static	getAllWidgetTypes ($db)
	Return all widget types as associative array. More...

static	getCurrentWidgetPath ($db)
	return current widget path More...

static	getFacebookLikeBox ()
	return the facebook likebox widget More...

static	getLoginBox ()
	return the user login box widget More...

static	loadWidgetsOfPage ($db, $page)
	Returns an array of all widgets that are linked with given page->id. More...

Detailed Description

Submenu widget - embed any menu on any page in any position.

Empty submenu Widget - for development and demo purpose

If you want to embed any menu on any page in any position, this should be the widget of your choice! It can handle every menu that you have created before within YaWK's menu system.

Author: Daniel Retzl danie.nosp@m.lret.nosp@m.zl@gm.nosp@m.ail..nosp@m.com

Copyright: 2018 Daniel Retzl

Version: 1.0.0

Definition at line 19 of file submenu.php.

Constructor & Destructor Documentation

◆ __construct()

YAWK\WIDGETS\SUBMENU\EMBED\submenu::__construct ( $db )

Load all widget settings from database and fill object.

Parameters

object $db Database Object

Load all widget settings on object init.

Definition at line 43 of file submenu.php.

         {
             // load this widget settings from db
             $this->widget = new widget();
             $settings = $this->widget->getWidgetSettingsArray($db);
             foreach ($settings as $property => $value) {
                 $this->$property = $value;
             }
  
             // set sidebar property
             if (isset($this->widget->data['sidebar'])){
                 $this->sidebar = $this->widget->data['sidebar'];
             }
             else {
                 $this->sidebar = 'false';
             }
  
             // check if sidebar is set
             if ($this->sidebar === 'true')
             {   // include sidebar js
                 echo '<script src="system/widgets/submenu/sidebar.js" type="text/javascript"></script>';
                 // include sidebar css
                 echo '<link rel="stylesheet" href="system/widgets/submenu/sidebar.css">';
             }
  
             // check if menu obj is set
             if (!isset($menu))
             {
                 require_once 'system/classes/menu.php';
                 $menu = new \YAWK\menu();
             }

References $db, $settings, $value, and YAWK\widget\getWidgetSettingsArray().

Member Function Documentation

◆ displaySubMenu()

YAWK\WIDGETS\SUBMENU\EMBED\submenu::displaySubMenu	(	$db,
		$menuID
	)

display any subMenu (used by widgets to get any menu in any position)

Copyright: 2009-2016 Daniel Retzl @license https://opensource.org/licenses/MIT

Version: 1.0.0

Parameters

object	$db	database
int	$menuID	the menuID to get data

Parameters

db $db

Definition at line 122 of file submenu.php.

         {   /** @param db $db */
  
             // check if menu name should be displayed
             if ($this->showMenuName)
             {   // get menu name from db
                 $menuName = "<li class=\"list-group-item\"><b>".\YAWK\menu::getMenuNameByID($db, $menuID)."</b><li>";
             }
             else
             {   // don't show menu name
                 $menuName = '';
             }
  
             // get menu entries and draw navbar
             $res = $db->query("SELECT * FROM {menu}
                                WHERE published = 1 
                                AND menuID = '".$menuID."' 
                                ORDER by sort, title");
  
             $subMenuItem = '';
             $subMenuClass = '';
             $subMenuItemClass = '';
             while ($row = mysqli_fetch_assoc($res))
             {
                 // check if target is set
                 if (!empty($row['target']))
                 {   // target is set
                     $row['target'] = ' target="'.$row['target'].'"';
                 }
                 else
                 {   // target is not set
                     $row['target'] = '';
                 }
  
                 // check if subMenu class is set
                 if (!empty($this->subMenuClass)){
                     $subMenuClass = ' class="'.$this->subMenuClass.'"';
                 }
                 else
                 {   // subMenuClass is not set
                     $subMenuClass = '';
                 }
  
                 // check if subMenuItem class is set
                 if (!empty($this->subMenuItemClass)){
                     $submenuItemClass = ' class="'.$this->subMenuItemClass.'"';
                 }
                 else
                 {   // subMenuItemClass is not set
                     $subMenuItemClass = '';
                 }
  
                 // check if icon is set
                 if (isset($row['icon']))
                 {   // set icon markup
                     $icon = '<i class="'.$row["icon"].' text-muted"></i>';
                 }
                 else
                 {   // no icon set
                     $icon = "";
                 }
  
                 // add menu item to menu
                 $subMenuItem .= '<li class="list-group-item hvr-grow"><small>'.$icon.'&nbsp;&nbsp;<a href="'.$row['href'].'"'.$subMenuItemClass.$row['target'].'>'.$row['text'].'</a></small></li>';
             }
  
             // if sidebar is set, start sidebar markup
             if ($this->sidebar === 'true') {   // include sidebar js
                 echo '<button class="openbtn" id="openSubmenuBtn">☰</button>';
                 // wrap menu in sidebar (start)
                 $this->drawSidebarStart();
             }
  
             // draw subMenu
             echo '<div id="subMenu"'.$subMenuClass.'>
                     <ul class="list-group" style="cursor:pointer;">'.$menuName.' ';
             echo ' '.$subMenuItem.'</ul>
                   </div>';
  
             // if sidebar is set, close sidebar
             if ($this->sidebar === 'true')
             {   // wrap menu in sidebar (end)
                 $this->drawSidebarEnd();
             }

References $db, YAWK\WIDGETS\SUBMENU\EMBED\submenu\$menuID, $menuName, $res, YAWK\WIDGETS\SUBMENU\EMBED\submenu\$subMenuClass, YAWK\WIDGETS\SUBMENU\EMBED\submenu\$subMenuItemClass, YAWK\WIDGETS\SUBMENU\EMBED\submenu\drawSidebarEnd(), and YAWK\WIDGETS\SUBMENU\EMBED\submenu\drawSidebarStart().

Referenced by YAWK\WIDGETS\SUBMENU\EMBED\submenu\drawMenu().

◆ drawMenu()

YAWK\WIDGETS\SUBMENU\EMBED\submenu::drawMenu ( $db )

Definition at line 109 of file submenu.php.

111 {

112 $this->displaySubMenu($db, $this->menuID);

YAWK\WIDGETS\SUBMENU\EMBED\submenu\displaySubMenu

displaySubMenu($db, $menuID)

display any subMenu (used by widgets to get any menu in any position)

Definition: submenu.php:122

References $db, and YAWK\WIDGETS\SUBMENU\EMBED\submenu\displaySubMenu().

Referenced by YAWK\WIDGETS\SUBMENU\EMBED\submenu\init().

◆ drawSidebarEnd()

YAWK\WIDGETS\SUBMENU\EMBED\submenu::drawSidebarEnd ( )

draw sidebar end

If $this->sidebar is set to true, this function will be called after menu entry and closes the wrapping menu sidebar div.

Returns: void

Definition at line 104 of file submenu.php.

                                         : void
         {
             echo '</div>';

Referenced by YAWK\WIDGETS\SUBMENU\EMBED\submenu\displaySubMenu().

◆ drawSidebarStart()

YAWK\WIDGETS\SUBMENU\EMBED\submenu::drawSidebarStart ( )

draw sidebar start

If $this->sidebar is set to true, this function will be called before menu entry and wrap the menu in a sidebar div.

Returns: void

Definition at line 93 of file submenu.php.

                                           : void
         {
             echo '<div id="mySidebar" class="sidebar shadow"><a href="javascript:void(0)" class="btn btn-default" onclick="closeNav()">x</a>';

Referenced by YAWK\WIDGETS\SUBMENU\EMBED\submenu\displaySubMenu().

◆ init()

YAWK\WIDGETS\SUBMENU\EMBED\submenu::init ( $db )

Init submenu widget and call a function for demo purpose.

submenu Widget Init

Definition at line 80 of file submenu.php.

         {
             // draw headline
             echo $this->getHeading($this->submenuHeading, $this->submenuSubtext);
             $this->drawMenu($db);

References $db, YAWK\WIDGETS\SUBMENU\EMBED\submenu\drawMenu(), and YAWK\widget\getHeading().

Member Data Documentation

◆ $menuID

string int YAWK\WIDGETS\SUBMENU\EMBED\submenu::$menuID = ''

Definition at line 28 of file submenu.php.

Referenced by YAWK\WIDGETS\SUBMENU\EMBED\submenu\displaySubMenu().

◆ $showMenuName

bool YAWK\WIDGETS\SUBMENU\EMBED\submenu::$showMenuName = false

Definition at line 36 of file submenu.php.

◆ $sidebar

string YAWK\WIDGETS\SUBMENU\EMBED\submenu::$sidebar = 'false'

Definition at line 34 of file submenu.php.

◆ $subMenuClass

string YAWK\WIDGETS\SUBMENU\EMBED\submenu::$subMenuClass

Definition at line 30 of file submenu.php.

Referenced by YAWK\WIDGETS\SUBMENU\EMBED\submenu\displaySubMenu().

◆ $submenuHeading

string YAWK\WIDGETS\SUBMENU\EMBED\submenu::$submenuHeading = ''

Definition at line 24 of file submenu.php.

◆ $subMenuItemClass

string YAWK\WIDGETS\SUBMENU\EMBED\submenu::$subMenuItemClass

Definition at line 32 of file submenu.php.

Referenced by YAWK\WIDGETS\SUBMENU\EMBED\submenu\displaySubMenu().

◆ $submenuSubtext

string YAWK\WIDGETS\SUBMENU\EMBED\submenu::$submenuSubtext = ''

Definition at line 26 of file submenu.php.

◆ $widget

YAWK\WIDGETS\SUBMENU\EMBED\submenu::$widget = ''

Definition at line 22 of file submenu.php.

The documentation for this class was generated from the following file:

/var/www/htdocs/yawk.io/system/widgets/submenu/classes/submenu.php

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ displaySubMenu()

◆ drawMenu()

◆ drawSidebarEnd()

◆ drawSidebarStart()

◆ init()

Member Data Documentation

◆ $menuID

◆ $showMenuName

◆ $sidebar

◆ $subMenuClass

◆ $submenuHeading

◆ $subMenuItemClass

◆ $submenuSubtext

◆ $widget