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 cGuiBackendHelpbox

Class cGuilBackendHelpbox. Renders a little helpbox to display information next to a form element

Package: Core\GUI
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Mischa Holz
Located at classes/gui/class.backendhelpbox.php
Methods summary
public
# __construct( string $helpText, string $imageURL = '' )

Basic constructor. Assigns a help text

Basic constructor. Assigns a help text

Parameters

$helpText
string
$helpText the text that will appear in the tooltip
$imageURL
string
$imageURL This image will be used for the tooltip
public
# setHelpText( string $helpText )

Set the help text to a new value

Set the help text to a new value

Parameters

$helpText
string
$helpText the text that will appear in the tooltip
public
# setImageURL( string $imageURL )

Set the image for the tooltip

Set the image for the tooltip

Parameters

$imageURL
string
$imageURL the image file
public string|null
# render( string $returnAsString = true )

Render the helpbox. Please make sure that the atooltip.jquery.js and the atooltip.css are embedded on the site

Render the helpbox. Please make sure that the atooltip.jquery.js and the atooltip.css are embedded on the site

Parameters

$returnAsString
string
$returnAsString if true the rendered button will be returned. Otherwise it will be echoed

Returns

string|null
rendered button or nothing if it's been printed
Properties summary
protected string $helpText
#

the text that will appear in the tooltip

the text that will appear in the tooltip

protected mixed $imageURL
#
CMS CONTENIDO 4.9.5 API documentation generated by ApiGen 2.8.0