Class: MenuAdminService

Source Location: /CORE/system/classes/menu/MenuAdminService.php

Class MenuAdminService

Class Overview

Class used for administrating BIGACE "Menu" Items

Located in /CORE/system/classes/menu/MenuAdminService.php [line 40]

MasterItemType
   |
   --Itemtype
      |
      --ItemService
         |
         --ItemAdminService
            |
            --MenuAdminService
Author(s):
  • Kevin Papst
Information Tags:
Version:  $Id: MenuAdminService.php,v 1.21 2009/02/27 23:48:32 kpapst Exp $
Copyright:  Copyright (C) Kevin Papst
License:  GNU Public License

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From ItemAdminService

ItemAdminService::ItemAdminService()
ItemAdminService::addCategoryLink()
ItemAdminService::buildUniqueName()
ItemAdminService::buildUniqueNameSafe()
ItemAdminService::changeItem()
Changes an existing File in the System.
ItemAdminService::changeItemColumnLanguage()
ItemAdminService::createDataArrayForParent()
ItemAdminService::createItem()
Inserts a new Item, NOT a language version!
ItemAdminService::createLanguageVersion()
Creates a NEW language for the given Item.
ItemAdminService::deleteAllProjectNum()
ItemAdminService::deleteAllProjectText()
ItemAdminService::deleteItem()
Deletes an Item from BIGACE, including all Language Versions, its rights and categorys.
ItemAdminService::deleteItemLanguage()
This returns:
ItemAdminService::getMaxPositionForParentID()
Get the highest Position within the given Tree.
ItemAdminService::initItemAdminService()
Has to be called by implementing classes.
ItemAdminService::isAllowed()
Returns whether the uploaded file type is allowed by the System.
ItemAdminService::isSupportedFile()
ItemAdminService::lowerPosition()
Moves the Item a position down.
ItemAdminService::moveItem()
Moves an Item to a new Parent ID.
ItemAdminService::raisePosition()
Moves the Item a position up.
ItemAdminService::refreshHistoryVersionContent()
Gets the specified History version and uses its Content to replace the Content of the Items published Version.
ItemAdminService::registerAsFile()
ItemAdminService::registerUploadedFile()
Registers a File that was posted to the system.
ItemAdminService::removeAllCategoryLinks()
ItemAdminService::removeCategoryLink()
ItemAdminService::setItemFlag()
$flag must be one of:
ItemAdminService::setItemPosition()
Sets the new Item position.
ItemAdminService::setParent()
Move an Item to a new Parent.
ItemAdminService::setProjectNum()
Inserts or updates the given numeric project value.
ItemAdminService::setProjectText()
Inserts or updates the given textual project value.
ItemAdminService::updateContent()
Updates the Content in the File that is fetched from Item->getFullURL().
ItemAdminService::updateItemContent()
Overwrite this method to pipe update Calls to your ItemService implementation.
ItemAdminService::updateItemWithUpload()
Updates the given Items Content with the last uploaded File.
ItemAdminService::_changeItemLanguageWithTimestamp()
Executes an Update on the given Item Language Version.

Inherited From ItemService

ItemService::ItemService()
Initalizes a new ItemService for the given Itemtype.
ItemService::countAllItems()
Counts all Items, except TOP_LEVEL.
ItemService::countLevel()
Calculates the Level beneath TOP LEVEL.
ItemService::getItem()
ItemService::getItemLanguageEnumeration()
ItemService::getItemtype()
ItemService::getLastEditedItems()
Get the last edited Items for the specified Language.
ItemService::getLightTree()
ItemService::getLightTreeForLanguage()
ItemService::getTree()
ItemService::getTreeForLanguage()
ItemService::getTreeWalker()
ItemService::getWayHome()
ItemService::increaseViewCounter()
ItemService::initItemService()
ItemService::isChildOf()
Returns true if "child" is somewhere beneath "parent" in the Menu Tree.
ItemService::isLeaf()
Checks whether the given Item is a Leaf.

Inherited From Itemtype

Itemtype::Itemtype()
Itemtype::getClass()
Itemtype::getClassName()
Itemtype::getCommand()
Itemtype::getDirectory()
Itemtype::getItemtypeID()
Itemtype::initItemtype()

Inherited From MasterItemType

MasterItemType::MasterItemType()
Empty Constructor.
MasterItemType::countItemtypes()
Returns how many Itemtypes are known by the System.
MasterItemType::getClassForItemType()
Returns a new instance of the Class for the given Itentype ID.
MasterItemType::getClassNameForItemType()
Returns the Classname for the given Itentype ID.
MasterItemType::getCommandForItemType()
Return the Command for the given Itemtype ID.
MasterItemType::getDirectoryForItemType()
Return the Directory for the given Itemtype ID.
MasterItemType::getItemTypeForCommand()
Get the Itemtype ID for the given Command (or null).
MasterItemType::getSelectColumns()
Returns the Select Columns to be used for Item- and Treeselects.

[ Top ]
Method Summary
MenuAdminService   __construct()   Instantiates a MenuAdminService.
void   buildUniqueName()   overwritten to add proper file extension
void   createItemLanguageVersion()  
the   createMenu()   Creates Menu with given values.
void   updateItemContent()   Overwritten to make sure to get each update.
void   updateMenuContent()   This method prepares the Content and Meta information to be saved correctly.

[ Top ]
Methods
Constructor __construct  [line 49]

  MenuAdminService __construct( )

Instantiates a MenuAdminService.



[ Top ]
buildUniqueName  [line 179]

  void buildUniqueName( $name, [ $extension = '.html']  )

overwritten to add proper file extension

Parameters:
   $name: 
   $extension: 

API Tags:
Access:  protected


Redefinition of:
ItemAdminService::buildUniqueName()

[ Top ]
createItemLanguageVersion  [line 114]

  void createItemLanguageVersion( $id, $copyLangID, $data  )

Parameters:
   $id: 
   $copyLangID: 
   $data: 


[ Top ]
createMenu  [line 76]

  the createMenu( $data  )

Creates Menu with given values.

Parameters:
   $data: 

API Tags:
Return:  new Menu ID or FALSE


[ Top ]
updateItemContent  [line 170]

  void updateItemContent( $id, $langid, $content, [ $data = array()]  )

Overwritten to make sure to get each update.

Parameters:
   $id: 
   $langid: 
   $content: 
   $data: 


Redefinition of:
ItemAdminService::updateItemContent()
Overwrite this method to pipe update Calls to your ItemService implementation.

[ Top ]
updateMenuContent  [line 142]

  void updateMenuContent( $id, $langid, $content, [ $data = array()]  )

This method prepares the Content and Meta information to be saved correctly.

If you update Menu Content, always use this method and NOT the generic method

!

  • Absolute links will be replaced by relative ones
  • Removes all possible Session IDs from links and image tags
  • Prepares the Search Content
After all then Menu will be updated with these Informations, including timestamp and author.

Parameters:
   $id: 
   $langid: 
   $content: 
   $data: 


[ Top ]