Overview

Packages

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

Classes

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

Class cGuiBackendHelpbox

The class cGuiBackendHelpbox allows to render help boxes (aka tooltips) to be displayed anywhere on a CONTENIDO backend page.

These help boxes contain a help text and may optionally contain an image.

If using this class please make sure that the atooltip.jquery.js and the atooltip.css are embedded in the pages template.

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 = '' )

Constructor to create an instance of this class.

Constructor to create an instance of this class.

Create a new backend help box containing a help text and an optional image URL.

Parameters

$helpText
string
$helpText the text that will appear in the help box
$imageURL
string
$imageURL [optional] This image will be used for the help box
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 help box
public
# setImageURL( string $imageURL )

Set the image for the help box.

Set the image for the help box.

Parameters

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

Render the help box.

Render the help box.

Parameters

$return
boolean
$return [optional] If true the rendered markup will be returned. Otherwise it will be echoed.

Returns

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

Text that will be displayed in the help box.

Text that will be displayed in the help box.

protected string $imageURL
#

URL of the image that will appear in the help box.

URL of the image that will appear in the help box.

CMS CONTENIDO 4.10.0 API documentation generated by ApiGen 2.8.0