nexus
[ class tree: nexus ] [ index: nexus ] [ all elements ]
Packages:
bitweaver
article
blogs
boards
calendar
categories
chatterbox
fisheye
gatekeeper
hotwords
install
kernel
languages
liberty
messages
multisites
newsletters
nexus
pdf
PHPMailer
pigeonholes
protector
quicktags
quota
rss
search
shoutbox
Smarty
stars
stats
stickies
treasury
TreeMaker
users
wiki


Files:
Nexus.php
NexusSystem.php

subpackage functions
menus.php
menu_items.php
menu_lookup_inc.php
menu_sort.php
servicefunctions_inc.php

subpackage plugins
menu.formelements.php
menu.suckerfish.php
menu.tikiwiki.php

Classes:
Nexus
   Nexus
NexusSystem

Class: Nexus

Source Location: d:\website\PhpDocumentor\/nexus/Nexus.php

Class Overview

BitBase
   |
   --LibertyBase
      |
      --LibertySystem
         |
         --NexusSystem
            |
            --Nexus

Variables

Methods

Inherited Variables

Class: NexusSystem

NexusSystem::$mPlugins

Class: LibertySystem

LibertySystem::$mContentStatus
LibertySystem::$mContentTypes
LibertySystem::$mDataTags
LibertySystem::$mPluginFileName
LibertySystem::$mSystem

Class: BitBase

BitBase::$dType
BitBase::$mCacheTime
BitBase::$mDb
BitBase::$mErrors
BitBase::$mInfo
BitBase::$mLogs
BitBase::$mName
BitBase::$mSuccess

Inherited Methods

Class: NexusSystem

NexusSystem::NexusSystem()
Initiate class

Class: LibertySystem

LibertySystem::LibertySystem()
Initiate Class
LibertySystem::getContentStatus()
getContentStatus
LibertySystem::getContentTypeDescription()
Get the description of a given content type
LibertySystem::getMimeThumbnailURL()
Get the URL to the icon for the mime type passed in. This should probably check for files of multiple image types instead of just jpg
LibertySystem::getPluginFunction()
getPluginFunction
LibertySystem::getPluginInfo()
getPluginInfo
LibertySystem::getService()
Get the service details of a given package
LibertySystem::hasService()
Check to see if a package has any service capabilities
LibertySystem::invokeServiceFunctionR()
Return an associate array of the non empty return values of all the functions with the given arguments
LibertySystem::isPluginActive()
Check to see if a given plugin is activ or not
LibertySystem::loadActivePlugins()
Load only active plugins from disk
LibertySystem::loadContentTypes()
Load all available content types into $this->mContentTypes
LibertySystem::registerContentType()
Register new content type
LibertySystem::registerDataTag()
Allow data plugins to register their tag
LibertySystem::registerPlugin()
Allow plugins to register themselves using this function. Data is added directly to the list of existing plugins
LibertySystem::registerService()
Register package as service - hash added to $this->mServices
LibertySystem::resetAllPluginSettings()
This function will purge all plugin settings set in kernel_config. useful when the path to plugins changes or plugins don't seem to be working
LibertySystem::scanAllPlugins()
Load all plugins found in specified directory Use loadActivePlugins to load only the active plugins
LibertySystem::setActivePlugin()
set a single plugin as active and store the appropriate information in the database
LibertySystem::setActivePlugins()
setActivePlugins

Class: LibertyBase

LibertyBase::LibertyBase()
Constructor building on BitBase object
LibertyBase::getLibertyObject()
Given a content_id, this will return and object of the proper type

Class: BitBase

BitBase::BitBase()
During initialisation, we assign a name which is used by the class.
BitBase::debug()
Switch debug level in database
BitBase::display()
This method should be THE method used to display a template. php files should not access $gBitSmarty directly.
BitBase::getDb()
Return pointer to current Database
BitBase::getField()
Returns entry from the mInfo hash if field exists
BitBase::isDatabaseValid()
Determines if there is a valide database connection
BitBase::prepGetList()
Prepares parameters with default values for any getList function
BitBase::setDatabase()
Sets database mechanism for the instance
BitBase::verifyId()
Determines if any given variable exists and is a number

Class Details

[line 20]


[ Top ]

Class Variables

$mMenuId =

[line 24]

Primary key for the menu


Type:   mixed


[ Top ]


Class Methods

constructor Nexus [line 29]

Nexus Nexus( [ $pMenuId = NULL])

Initialisation of this class



Parameters:

   $pMenuId  

[ Top ]

method checkUserPermission [line 161]

menu checkUserPermission( $pMenuHash $pMenuHash)

Strip out all items a user doesn't have permission to view



Tags:

return:  containing only items user is allowed to view


Parameters:

$pMenuHash   $pMenuHash   full menu as supplied by '$this->getItemList( $pMenuId );'

[ Top ]

method createMenuTree [line 113]

menu createMenuTree( $pMenuHash $pMenuHash, [$pStripped $pStripped = FALSE], [ $parent_id = 0], [ $pForceBuild = FALSE])

Create usable menu tree



Tags:

return:  with all menu items sorted with first and last items of each 'level' marked. items that contain siblings are marked with 'head' = TRUE;


Parameters:

$pMenuHash   $pMenuHash   full menu as supplied by '$this->getItemList( $pMenuId );'
$pStripped   $pStripped   if set to true, removes all permissions, user isn't part of
   $parent_id  
   $pForceBuild  

[ Top ]

method expungeDeadItems [line 515]

titles expungeDeadItems( [$pMenuId $pMenuId = NULL])

Remove items to content that has been removed



Tags:

return:  of links removed
TODO:  check for items in structures. if they don't exist there, replace them with the appropriate content id


Parameters:

$pMenuId   $pMenuId   menu from which we want to remove dead links

[ Top ]

method expungeItem [line 463]

deleted expungeItem( [$pItemId $pItemId = NULL], [ $pWriteCache = TRUE])

Delete item



Tags:

return:  item information


Parameters:

$pItemId   $pItemId   item to be removed
   $pWriteCache  

[ Top ]

method expungeMenu [line 261]

number expungeMenu( $pMenuId)

Delete menu and associated menu items from db



Tags:

return:  of errors encountered


Parameters:

   $pMenuId  

[ Top ]

method getChildItems [line 181]

array getChildItems( $pMenuHash $pMenuHash, [ $parent_id = 0])

Get all items in $pMenuHash that have a given parent_id



Tags:

return:  of items with a given parent_id


Parameters:

$pMenuHash   $pMenuHash   full menu as supplied by '$this->getItemList( $pMenuId );'
   $parent_id  

[ Top ]

method getGalleryListMenu [line 776]

void getGalleryListMenu( [ $pParentId = NULL])

This is not in use yet. would be good if this could be updated directly from the db



Parameters:

   $pParentId  

[ Top ]

method getItemList [line 287]

all getItemList( [$pItemId $pMenuId = NULL], [$pMenuId $pItemId = NULL])

Get menu items from the database



Tags:

return:  menu items with a given menu ID


Parameters:

$pItemId   $pMenuId   ID of menu item to get. if set, we only get this item.
$pMenuId   $pItemId   ID of menu to get

[ Top ]

method getMenu [line 54]

void getMenu( [$pMenuId $pMenuId = NULL])

Get menu information from database



Parameters:

$pMenuId   $pMenuId   menu id of the menu we want information from

[ Top ]

method getMenuList [line 79]

void getMenuList( [$pMenuId $pFindString = NULL], [ $pSortMode = NULL], [ $pOffset = NULL], [ $pMaxRows = NULL])

Get menu information from database



Parameters:

$pMenuId   $pFindString   menu id of the menu we want information from
   $pSortMode  
   $pOffset  
   $pMaxRows  

[ Top ]

method importStructure [line 643]

number importStructure( [ $pStructureId = NULL])

Imports a structure from liberty_structures to nexus including hierarchy



Tags:

return:  of errors encountered


Parameters:

   $pStructureId  

[ Top ]

method isValid [line 195]

TRUE isValid( )

Validate that a menu is being loaded and present



Tags:

return:  if all is ok


[ Top ]

method load [line 41]

void load( )

Load the menu



[ Top ]

method moveItemEast [line 568]

void moveItemEast( [$pItemId $pItemId = NULL])

Move item east



Parameters:

$pItemId   $pItemId   item id of item to be moved

[ Top ]

method moveItemNorth [line 621]

void moveItemNorth( [$pItemId $pItemId = NULL])

Move item north



Parameters:

$pItemId   $pItemId   item id of item to be moved

[ Top ]

method moveItemSouth [line 599]

void moveItemSouth( [$pItemId $pItemId = NULL])

Move item south



Parameters:

$pItemId   $pItemId   item id of item to be moved

[ Top ]

method moveItemWest [line 538]

void moveItemWest( [$pItemId $pItemId = NULL])

Move item west



Parameters:

$pItemId   $pItemId   item id of item to be moved

[ Top ]

method printUrl [line 327]

url printUrl( $pItemHash $pItemHash)

Create the correct url for a given item



Parameters:

$pItemHash   $pItemHash   complete item hash

[ Top ]

method rewriteMenuCache [line 714]

number rewriteMenuCache( $pMenuId 0)

rewrites all menu cache files. particularly important when menus have been renamed or deleted



Tags:

return:  of errors encountered


Parameters:

$pMenuId   0   menu id of the menu for which we want to create a cache file

[ Top ]

method storeItem [line 436]

the storeItem( parent_id &$pParamHash, after_ref_id 1, title 2)

Create a menu item entry



Tags:

return:  new entries item_id or FALSE if not created.


Parameters:

after_ref_id   1   The entry to add this one after. If NULL, put it in position 0.
title   2   The wiki page to reference
parent_id   &$pParamHash   The parent entry to add this to. If NULL, create new structure.

[ Top ]

method storeMenu [line 237]

new storeMenu( menu_id &$pParamHash, title 1, description 2, menu_type 3, editable 4)

Store menu in db



Tags:

return:  menu menu_id or FALSE if not created


Parameters:

title   1   title of menu
description   2   description of menu
menu_type   3   type of menu
editable   4   if menu is editable by other users - takes 0 or 1
menu_id   &$pParamHash   if set, will update given menu - if not set, we create a new entry in the db

[ Top ]

method verifyItem [line 386]

number verifyItem( &$pParamHash)

Verify if a given menu item contains all required information and prepare menu_items table for item insertion.



Tags:

return:  of errors encountered


Parameters:

   &$pParamHash  

[ Top ]

method verifyMenu [line 203]

number verifyMenu( &$pParamHash)

Check if all required items are present for menu creation / insertion



Tags:

return:  of errors encountered


Parameters:

   &$pParamHash  

[ Top ]

method verifyRsrc [line 362]

fixed verifyRsrc( &$pParamHash)

Verify rsrc handed to us and specify what type it is



Tags:

return:  rsrc and corresponding rsrc_type


Parameters:

   &$pParamHash  

[ Top ]

method writeMenuCache [line 741]

number writeMenuCache( [$pMenuId $pMenuId = NULL])

writes cache files to where the plugins determine



Tags:

return:  of errors encountered


Parameters:

$pMenuId   $pMenuId   menu id of the menu for which we want to create a cache file

[ Top ]

Documentation generated on Thu, 15 Feb 2007 20:46:13 +0000 by phpDocumentor 1.3.0