Overview

Packages

  • Core
    • Authentication
    • Backend
    • Cache
    • CEC
    • Chain
    • ContentType
    • Database
    • Datatype
    • Debug
    • Exception
    • Frontend
      • Search
      • URI
      • Util
    • GenericDB
      • Model
    • GUI
      • HTML
    • I18N
    • LayoutHandler
    • Log
    • Security
    • Session
    • Util
    • Validation
    • Versioning
    • XML
  • Module
    • ContentSitemapHtml
    • ContentSitemapXml
    • ContentUserForum
    • NavigationTop
  • mpAutoloaderClassMap
  • None
  • Plugin
    • ContentAllocation
    • CronjobOverview
    • FormAssistant
    • FrontendLogic
    • FrontendUsers
    • Linkchecker
    • ModRewrite
    • Newsletter
    • Repository
      • FrontendNavigation
      • KeywordDensity
    • SearchSolr
    • SmartyWrapper
    • UrlShortener
    • UserForum
    • Workflow
  • PluginManager
  • Setup
    • Form
    • GUI
    • Helper
      • Environment
      • Filesystem
      • MySQL
      • PHP
    • UpgradeJob

Classes

  • ArticleForumRightBottom
  • cApiClickableAction
  • cApiClickableQuestionAction
  • cGuiBackendHelpbox
  • cGuiFileOverview
  • cGuiFoldingRow
  • cGuiList
  • cGuiMenu
  • cGuiNavigation
  • cGuiNotification
  • cGuiObjectPager
  • cGuiPage
  • cGuiScrollList
  • cGuiSourceEditor
  • cGuiTableForm
  • cGuiTree
  • cPager
  • cTemplate
  • cTree
  • cTreeItem
  • NoteLink
  • NoteList
  • NoteListItem
  • NoteView
  • TODOBackendList
  • TODOLink
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class cGuiNavigation

Backend navigaton class. Renders the header navigation document containing the navigtion structure.

Package: Core\GUI
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Jan Lengowski
Located at classes/gui/class.navigation.php
Methods summary
public
# __construct( )

Constructor. Loads the XML language file using cXmlReader.

Constructor. Loads the XML language file using cXmlReader.

Throws

cException
if XML language files could not be loaded
public string
# getName( string $location )

Extracts caption from the XML language file including plugins extended multilang version.

Extracts caption from the XML language file including plugins extended multilang version.

Parameters

$location
string
$location The location of navigation item caption. Feasible values are - "{xmlFilePath};{XPath}": Path to XML File and the XPath value separated by semicolon. This type is used to extract caption from a plugin XML file. - "{XPath}": XPath value to extract caption from CONTENIDO XML file

Returns

string
The found caption

Throws

cException
if XML language files could not be loaded
public
# _buildHeaderData( )

Reads and fills the navigation structure data

Reads and fills the navigation structure data

public
# buildHeader( integer $lang )

Function to build the CONTENIDO header document for backend

Function to build the CONTENIDO header document for backend

Parameters

$lang
integer
$lang The language to use for header doc creation
public string
# _renderLanguageSelect( )

Renders the language select box

Renders the language select box

Returns

string
protected string
# _renderClientSelect( )

Renders a select box where the client can be selected as well as an edit button.

Renders a select box where the client can be selected as well as an edit button.

Returns

string
rendered HTML
public boolean
# hasErrors( )

Returns true if the class encountered errors while building the navigation

Returns true if the class encountered errors while building the navigation

Returns

boolean
public array
# getErrors( )

Returns an array of localized error messages

Returns an array of localized error messages

Returns

array
Properties summary
public array $data array()
#

Array storing all data

Array storing all data

protected array $errors array()
#

Array storing all errors

Array storing all errors

CMS CONTENIDO 4.9.5 API documentation generated by ApiGen 2.8.0