bigace-classes

Files:
administration
AdminMenu.php
AdminMenuItem.php
AdminMenuItemDynamic.php
AdminRequestResult.php
AdminStyle.php
AdminStyleService.php
AdminSubMenu.php
AnswerViewDefinition.php
EditorContext.php
EditorSaveHelper.php
authentication
DefaultAuthenticator.php
category
Category.php
CategoryAdminService.php
CategoryItemEnumeration.php
CategoryList.php
CategoryService.php
CategoryTreeWalker.php
DBCategory.php
ItemCategoryEnumeration.php
configuration
ConfigurationAdmin.php
ConfigurationEntry.php
ConfigurationReader.php
IniHelper.php
consumer
Consumer.php
ConsumerDefinition.php
ConsumerDeinstaller.php
ConsumerHelper.php
ConsumerInstaller.php
ConsumerInstallHelper.php
ConsumerService.php
core
FileCache.php
Hooks.php
ServiceFactory.php
Session.php
email
email.php
EmailHelper.php
HtmlEmail.php
TextEmail.php
event
Event.php
EventDispatcher.php
EventListener.php
exception
AdministrationException.php
AuthenticationException.php
CMSException.php
CoreException.php
ExceptionHandler.php
LogEntry.php
MaintenanceException.php
MissingRightException.php
NoDeleteRightException.php
NoFunctionalRightException.php
NoReadRightException.php
NotAllowedException.php
NotFoundException.php
NoWriteRightException.php
RequestResultException.php
WrongArgumentException.php
file
File.php
FileAdminService.php
FileService.php
fright
Fright.php
FrightAdminService.php
FrightExporter.php
FrightImporter.php
FrightService.php
FrightStringsEnumeration.php
GroupFrightEnumeration.php
group
Group.php
GroupAdminService.php
GroupEnumeration.php
GroupService.php
image
Image.php
ImageAdminService.php
ImageService.php
item
EditorHelper.php
FutureItem.php
HistoryItem.php
Item.php
ItemAdminService.php
ItemEnumeration.php
ItemFutureService.php
ItemHelper.php
ItemHistoryAdminService.php
ItemHistoryEnumeration.php
ItemHistoryService.php
ItemProjectService.php
ItemRequest.php
ItemRequests.php
ItemService.php
ItemTreeWalker.php
Itemtype.php
ItemtypeHelper.php
MasterItemType.php
SimpleItemTreeWalker.php
UniqueNameAdminService.php
UniqueNameService.php
job
SessionCleanup.php
language
ItemFutureLanguageEnumeration.php
ItemLanguageEnumeration.php
Language.php
LanguageEnumeration.php
layout
Layout.php
LayoutService.php
logger
DBLogger.php
FileLogger.php
Logger.php
NullLogger.php
RuntimeLogger.php
XmlFileLogger.php
menu
ContentAdminService.php
ContentService.php
Menu.php
MenuAdminService.php
MenuService.php
modul
Modul.php
ModulEnumeration.php
ModulService.php
parser
BBCodeParser.php
LinkParser.php
PortletParser.php
UseCase.php
UseCaseEditContent.php
XmlToSqlParser.php
portlets
LastEditedItemsPortlet.php
LoginMaskPortlet.php
NavigationPortlet.php
QuickSearchPortlet.php
SkypeOnlinePortlet.php
ToolPortlet.php
TranslatedPortlet.php
principal
DefaultPrincipal.php
DefaultPrincipalService.php
right
GroupRight.php
ItemRightEnumeration.php
Right.php
RightAdminService.php
RightService.php
search
ItemSearch.php
MenuSearch.php
SearchResult.php
sql
AdoDBConnection.php
AdoDBResult.php
MySQLConnection.php
mysqldump.php
MySQLResult.php
SimpleMySQLConnection.php
SQLHelper.php
statistic
StatisticConnection.php
StatisticService.php
StatisticWriter.php
template
BigaceSmarty.php
MenuTemplate.php
SmartyDesign.php
SmartyService.php
SmartyStylesheet.php
SmartyTemplate.php
updates
AbstractConsumerUpdate.php
AbstractSystemUpdate.php
AbstractUpdate.php
SeparatorResult.php
UpdateManager.php
UpdateModul.php
UpdateResult.php
user
UserAdminService.php
UserAuthenticate.php
UserEnumeration.php
UserInfo.php
UserService.php
userdata
UserData.php
UserDataAdminService.php
UserDataService.php
util
ApplicationLinks.php
applications.php
CMSLink.php
FileLink.php
GenericForm.php
IdentifierHelper.php
ImageLink.php
IOHelper.php
LinkHelper.php
MenuLink.php
ObjectHelper.php
ResourceBundle.php
ResourceBundleHelper.php
ScriptLink.php
SmartyLink.php
Translations.php
util-captcha
B2EvoCaptcha.php
util-formular
CategorySelect.php
DesignSelect.php
EditorSelect.php
GroupSelect.php
LanguageSelect.php
ModulSelect.php
StylesheetSelect.php
TemplateSelect.php
WorkflowSelect.php
util-html
CData.php
CopyrightFooter.php
EmptyOption.php
HtmlElement.php
JavascriptHelper.php
Option.php
Select.php
util-links
ActivationLink.php
AddOnLink.php
AdministrationLink.php
AjaxItemContentLink.php
AjaxItemInfoLink.php
AuthenticateLink.php
EditorLink.php
HtmlMenuChooserLink.php
ImageChooserLink.php
ItemInfoLink.php
LoginFormularLink.php
LogoutLink.php
MenuChooserLink.php
ModulAdminLink.php
PortletAdminLink.php
RegistrationLink.php
SearchLink.php
SessionLanguageLink.php
ThumbnailLink.php
workflow
AssignWorkflowActivity.php
PendingReviewActivity.php
PublishingActivity.php
PublishingWorkflow.php
RejectChangesActivity.php
SingleReviewWorkflow.php
TerminatingActivity.php
Workflow.php
WorkflowActivity.php
WorkflowService.php

Class: Menu

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

Class Menu

Class Overview
Class Overview | Inherited Properties, Constants, and Methods | Method Summary | Methods Detail

Class used for handling Menus.

For currently used Text/Num/Date fields, see Item.php.

Located in /CORE/system/classes/menu/Menu.php [line 41] 

MasterItemType
   |
   --Itemtype
      |
      --Item
         |
         --Menu
Author(s):
  • Kevin Papst
Information Tags:
Version:  $Id: Menu.php,v 1.13 2008/02/12 23:14:49 kpapst Exp $
Copyright:  Copyright (C) Kevin Papst
License:  GNU Public License

Methods
[ Top ]
Inherited Properties, Constants, and Methods
Class Overview | Inherited Properties, Constants, and Methods | Method Summary | Methods Detail
Inherited Properties Inherited Methods Inherited Constants

Inherited From Item

Item::Item()
Full construtor for fetching an specified Item from the Database.
Item::exists()
Checks whether this Item exists or not.
Item::getCatchwords()
Returns the Item Catchwords.
Item::getChildren()
Returns all children of this item that are available in the same language as the item.
Item::getChilds()
Returns all children of this item that are available in the same language as the item.
Item::getContent()
Fetches the Content from the linked File.
Item::getCreateByID()
Returns the User ID this Item was created by.
Item::getCreateDate()
Returns the Timestamp, when the Item was created.
Item::getDescription()
Returns the Item Description.
Item::getFullURL()
Returns the absolute Path to the Items Content File.
Item::getID()
Returns the Item ID.
Item::getItemDate()
Returns the desired ItemDate field.
Item::getItemNum()
Returns the desired ItemNum field.
Item::getItemText()
Returns the desired ItemText field.
Item::getItemType()
Returns the Itemtype ID.
Item::getLanguageID()
Returns the Language ID of this Item.
Item::getLastByID()
Returns the ID of the last User that updated this Item.
Item::getLastDate()
Returns the timestamp of the last changes on this Item (like Description or Content).
Item::getMimetype()
Returns the Items Mimetype.
Item::getName()
Fetch the Items Name.
Item::getOriginalName()
Returns the original File Name. This MUST only work with uploaded Files.
Item::getParentID()
Returns the Parents Item ID.
Item::getPosition()
Returns the Position of this Item.
Item::getSize()
Returns the Size of the linked File.
Item::getUniqueName()
Returns the unique name, which is only a backup of the unique_name table for fast access.
Item::getURL()
Returns the URL where this Items Content is stored.
Item::getValidFrom()
Returns the Timestamp, from when this Item will be valid (and therefor visible).
Item::getValidTo()
Returns the Timestamp, until this Item is valid (and therefor visible).
Item::getViews()
Returns the amount of views for this Item.
Item::getWorkflowName()
Returns the name of the configured Workflow.
Item::hasChildren()
Checks if the Item has children in the same Language as the item.
Item::hasChilds()
Checks if the Item has children in the same Language as the item.
Item::isHidden()
returns whether the this items flag is set to hidden or not.
Item::isInTrash()
returns whether this items flag set to trashed or not.
Item::lastModified()
Returns the last modified date of the File (filemtime).
Item::toString()
Simple toString() implementation to make debugging easier.

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
Class Overview | Inherited Properties and Methods | Method Summary | Methods Detail
Menu   Menu()   Instantiates a Menu representing the given Menu ID.
String   getLayoutName()   Gets the Layout Name for this Menu.
Modul   getModul()   Gets the Modul that is linked to this Menu.
String   getModulID()   Gets the Modul ID for the current Menu.
Menu   getParent()   Gets a Menu instance that holds all information about the Parent MenuEntry.
void   isRoot()   Checks whether this is the Root Menu or not.

[ Top ]
Methods
Class Overview | Inherited Properties and Methods | Method Summary | Methods Detail
Constructor Menu  [line 53]

  Menu Menu( [int $id = null], [String $treetype = ITEM_LOAD_FULL], [String $languageID = '']  )

Instantiates a Menu representing the given Menu ID.

If you pass null as ID the Object will not be initialized but only instantiated.

 Parameters:
int   $id:  the Menu ID or null
String   $treetype:  the treetype
String   $languageID:  the Language ID


[ Top ]
getLayoutName  [line 72]

  String getLayoutName( )

Gets the Layout Name for this Menu.


API Tags:
Return:  the Layout Name


[ Top ]
getModul  [line 82]

  Modul getModul( )

Gets the Modul that is linked to this Menu.


API Tags:
Return:  the Modul for this Menu


[ Top ]
getModulID  [line 63]

  String getModulID( )

Gets the Modul ID for the current Menu.


API Tags:
Return:  the Modul ID


[ Top ]
getParent  [line 92]

  Menu getParent( )

Gets a Menu instance that holds all information about the Parent MenuEntry.


API Tags:
Return:  the Parent of this Menu


[ Top ]
isRoot  [line 100]

  void isRoot( )

Checks whether this is the Root Menu or not.



[ Top ]
This is the Developer Documentation of the BIGACE Web CMS.
It was generated using phpDocumentor 1.4.1
© 2002-2009 Kevin Papst. All rights reserved.