WIKINDX API trunk

MENU
in package

MENU

Configure, create and print menus

Table of Contents

Properties

$admin  : mixed
array
$basketList  : mixed
array
$bibliographies  : mixed
array
$bookmarkAdd  : mixed
string
$bookmarkArray  : mixed
array
$browserTabID  : mixed
string
$BT  : mixed
string
$collBrowseSub  : mixed
array
$collEditSub  : mixed
array
$db  : mixed
object
$enableMetadataMenu  : mixed
boolean
$ideasBasketList  : mixed
array
$ideasExist  : mixed
boolean
$lastIdeaList  : mixed
string
$lastMenuIndex  : mixed
int
$lastMulti  : mixed
string
$lastMultiMeta  : mixed
string
$lastSolo  : mixed
string
$lastThread  : mixed
string
$menuConfig  : mixed
array
$metadata  : mixed
array
$metadataExist  : mixed
boolean
$noMenu  : mixed
array
$plugin1  : mixed
array
$plugin2  : mixed
array
$plugin3  : mixed
array
$pubBrowseSub  : mixed
array
$pubEditSub  : mixed
array
$res  : mixed
array
$resourcesExist  : mixed
boolean
$search  : mixed
array
$session  : mixed
object
$stmt  : mixed
string
$store  : mixed
object
$superAdmin  : mixed
string
$userId  : mixed
int
$wikindx  : mixed
array
$wordprocessor  : mixed
array
$write  : mixed
string

Methods

addBT()  : array<string|int, mixed>
Add $this->BT to 'link' element of menus if browserTabID is enabled
addPlugin()  : mixed
Add plugins to main menus
checkQuarantine()  : bool
Quickly check if there are any quarantined resources
collectionArray()  : array<string|int, mixed>
Return array of menu items to browse collections from under the Resource|Browse menu.
configureAdminMenu()  : array<string|int, mixed>
Build Admin menu
configureMetadataMenu()  : array<string|int, mixed>
Build Metadata menu
configurePluginMenu()  : array<string|int, mixed>
Build PluginX menu
configureResourcesMenu()  : array<string|int, mixed>
Build Resources menu
configureSearchMenu()  : array<string|int, mixed>
Build Search menu
configureWikindxMenu()  : array<string|int, mixed>
Build Wikindx menu
configureWordprocessorMenu()  : array<string|int, mixed>
Build Word processor menu
discoverBookmarks()  : mixed
Discover any bookmarks
menuPluginInsert()  : mixed
Insert available plugin modules into menu system
printNoMenu()  : string
Print the menu for noMenu display
publisherArray()  : array<string|int, mixed>
Return array of menu items to edit publishers from under the Resource|Edit menu.
reduceMenuLevel()  : array<string|int, mixed>
Reduce the menu level according to user preference
setIdeasCondition()  : bool
set user/group ID conditions
tooltip()  : string
Render a tooltip

Properties

$admin

array

private mixed $admin = []

$basketList

array

private mixed $basketList

$bibliographies

array

private mixed $bibliographies

$bookmarkAdd

string

private mixed $bookmarkAdd

$bookmarkArray

array

private mixed $bookmarkArray

$browserTabID

string

private mixed $browserTabID = \FALSE

$BT

string

private mixed $BT = ''

$collBrowseSub

array

private mixed $collBrowseSub = []

$collEditSub

array

private mixed $collEditSub = []

$db

object

private mixed $db

$enableMetadataMenu

boolean

private mixed $enableMetadataMenu = \FALSE

$ideasBasketList

array

private mixed $ideasBasketList

$ideasExist

boolean

private mixed $ideasExist = \FALSE

$lastIdeaList

string

private mixed $lastIdeaList = \FALSE

$lastMenuIndex

int

private mixed $lastMenuIndex = 0

$lastMulti

string

private mixed $lastMulti = \FALSE

$lastMultiMeta

string

private mixed $lastMultiMeta

$lastSolo

string

private mixed $lastSolo = \FALSE

$lastThread

string

private mixed $lastThread

$menuConfig

array

private mixed $menuConfig = []

$metadata

array

private mixed $metadata = []

$metadataExist

boolean

private mixed $metadataExist = \FALSE

$noMenu

array

private mixed $noMenu = []

$plugin1

array

private mixed $plugin1 = []

$plugin2

array

private mixed $plugin2 = []

$plugin3

array

private mixed $plugin3 = []

$pubBrowseSub

array

private mixed $pubBrowseSub = []

$pubEditSub

array

private mixed $pubEditSub = []

$res

array

private mixed $res = []

$resourcesExist

boolean

private mixed $resourcesExist = \FALSE

$search

array

private mixed $search = []

$session

object

private mixed $session

$stmt

string

private mixed $stmt = \FALSE

$store

object

private mixed $store

$superAdmin

string

private mixed $superAdmin

$userId

int

private mixed $userId

$wikindx

array

private mixed $wikindx = []

$wordprocessor

array

private mixed $wordprocessor = []

$write

string

private mixed $write

Methods

addBT()

Add $this->BT to 'link' element of menus if browserTabID is enabled

private addBT(array<string|int, mixed> $array) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>
Return values
array<string|int, mixed>

addPlugin()

Add plugins to main menus

private addPlugin(string $menu, array<string|int, mixed> &$array) : mixed
Parameters
$menu : string
$array : array<string|int, mixed>

checkQuarantine()

Quickly check if there are any quarantined resources

private checkQuarantine() : bool
Return values
bool

collectionArray()

Return array of menu items to browse collections from under the Resource|Browse menu.

private collectionArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Array is empty if no collections

configureAdminMenu()

Build Admin menu

private configureAdminMenu() : array<string|int, mixed>
Return values
array<string|int, mixed>

configureMetadataMenu()

Build Metadata menu

private configureMetadataMenu() : array<string|int, mixed>
Return values
array<string|int, mixed>

configurePluginMenu()

Build PluginX menu

private configurePluginMenu(string $menu) : array<string|int, mixed>
Parameters
$menu : string

(one of 'plugin1', 'plugin2', or 'plugin3')

Return values
array<string|int, mixed>

configureResourcesMenu()

Build Resources menu

private configureResourcesMenu() : array<string|int, mixed>
Return values
array<string|int, mixed>

configureSearchMenu()

Build Search menu

private configureSearchMenu() : array<string|int, mixed>
Return values
array<string|int, mixed>

configureWikindxMenu()

Build Wikindx menu

private configureWikindxMenu() : array<string|int, mixed>
Return values
array<string|int, mixed>

configureWordprocessorMenu()

Build Word processor menu

private configureWordprocessorMenu() : array<string|int, mixed>
Return values
array<string|int, mixed>

discoverBookmarks()

Discover any bookmarks

private discoverBookmarks() : mixed

return bool

menuPluginInsert()

Insert available plugin modules into menu system

private menuPluginInsert() : mixed

printNoMenu()

Print the menu for noMenu display

private printNoMenu(array<string|int, mixed> $menu[, bool $returnLine = FALSE ]) : string
Parameters
$menu : array<string|int, mixed>
$returnLine : bool = FALSE

Default is FALSE

Return values
string

publisherArray()

Return array of menu items to edit publishers from under the Resource|Edit menu.

private publisherArray() : array<string|int, mixed>

Array is empty if no publishers

Return values
array<string|int, mixed>

reduceMenuLevel()

Reduce the menu level according to user preference

private reduceMenuLevel(array<string|int, mixed> $oldMenu, int $reduceLevel) : array<string|int, mixed>
Parameters
$oldMenu : array<string|int, mixed>
$reduceLevel : int
Return values
array<string|int, mixed>

setIdeasCondition()

set user/group ID conditions

private setIdeasCondition() : bool
Return values
bool

tooltip()

Render a tooltip

private tooltip(mixed $item) : string
Parameters
$item : mixed
Tags
pasram

string $item

Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results