Docs For Class layout

Description

class for creating layout, which means menus and blocks class also loads template in its constructor.

db
   |
   --layout

Variable Summary

static string $blocks_sec

static mixed $breadcrumbs

static array $menu

static mixed $module

static mixed $options

object uri $uri

Method Summary

static array getBaseModuleMenu (string $module)

static array getBlocks ()

static array getBlocksSec ()

static array getChildrenMenus (string $module)

static string getMainMenu ()

static array getMenuFromFile (string $module)

static string getModuleMenu ()

static array getSubMenu (string $sub)

static array getTopBlocks ()

static void parseMainMenuList ()

static string parseModuleMenu (array $menu, $type)

layout __construct ()

void loadMenus ()

Variables

static string $blocks_sec (line 38)

var: holds if user is user, admin or super or null .)
access: public

static mixed $breadcrumbs = array() (line 40)

access: public

static array $menu = array() (line 32)

var: menu for holding different menus (main / module / sub)
access: public

static mixed $module = NULL (line 44)

access: public

static mixed $options = array() (line 42)

access: public

object uri $uri (line 26)

var: object
access: public

Inherited Variables

Inherited from db

db::$dbh
db::$debug

Methods

static getBaseModuleMenu (line 156)

return: array with top level module menu
access: public

static array getBaseModuleMenu (string $module)

string $module: module name

static getBlocks (line 323)

method for getting all blocks to be used

blocks to use

return: blocks containing strings with html to display
access: public

static array getBlocks ()

static getBlocksSec (line 360)

method for getting all blocks to be used

blocks to use

return: blocks containing strings with html to display
access: public

static array getBlocksSec ()

static getChildrenMenus (line 117)

return: children menus items
access: public

static array getChildrenMenus (string $module)

string $module

static getMainMenu (line 303)

method for getting main module menu as html

return: containing menu module menu as html
access: public

static string getMainMenu ()

static getMenuFromFile (line 131)

return: menu as array
access: public

static array getMenuFromFile (string $module)

string $module: module e.g. content or content/article

static getModuleMenu (line 287)

method for getting module menu in a html form We just parse module menu and sub (module ) menu and return it as html.

return: containing menu as html
access: public

static string getModuleMenu ()

static getSubMenu (line 180)

return: with $_SUB_MODULE_MENU
access: public

static array getSubMenu (string $sub)

string $sub: name of sub menu to fetch $sub

static getTopBlocks (line 395)

method for getting top blocks which typicaly will be diplayed in a page header

where we can se which top blocks to parse

return: array of blocks containing strings with html to display
access: public

static array getTopBlocks ()

static parseMainMenuList (line 191)

function for parsing MAIN menu list.

Main menu is the menu holding all info about modules in database. Therefore it is also some sort of top level module menu.

access: public

static void parseMainMenuList ()

static parseModuleMenu (line 237)

method for parsing a module menu.

A module menu is a menu connected to a main menu item.

return: containing menu in html form ul li
access: public

static string parseModuleMenu (array $menu, $type)

array $menu: menu to parse
$type

Constructor __construct (line 52)

constructer method where we init our uri object and checks users credentials (admin / user) thus generating accurate menus for each group.

layout __construct ()

Redefinition of:

db::__construct(): constructor will try to call method connect

loadMenus (line 74)

method for loading menus. All Main menu entries is generated from database, while all module or submodule menus are generated from files (menu.inc).

access: public

void loadMenus ()

Inherited Methods

Inherited From db

db::__construct()
db::connect()
db::delete()
db::fatalError()
db::getDebug()
db::getNumRows()
db::insert()
db::prepareToPost()
db::rawQuery()
db::select()
db::selectAll()
db::selectOne()
db::selectQuery()
db::simpleSearch()
db::simpleSearchCount()
db::update()