class UserInterface (View source)

Useful functions for generating elements on the Concrete interface.

Properties

static $menuItems

Methods

string
submit(string $text, bool|string $formID = false, string $buttonAlign = 'right', string $innerClass = null, array $args = array())

Generates a submit button in the Concrete style.

string
button(string $text, string $href, string $buttonAlign = 'right', string $innerClass = null, array $args = array())

Generates a simple link button in the Concrete style.

string
buttonJs(string $text, string $onclick, string $buttonAlign = 'right', string $innerClass = null, array $args = array())

Generates a JavaScript function button in the Concrete style.

button_js($text, $onclick, $buttonAlign = 'right', $innerClass = null, $args = array()) deprecated

No description

string
buttons(string $buttons = null)

Outputs button text passed as arguments with a special Concrete wrapper for positioning $bh->buttons($myButton1, $myButton2, $myButton3); .

string
getQuickNavigationLinkHTML(Page $c)

No description

bool
showWhiteLabelMessage()

No description

string
getToolbarLogoSRC()

No description

bool
showNewsflowOverlay()

No description

bool
showHelpOverlay()

Shall we show the introductive help overlay?

trackHelpOverlayDisplayed()

No description

clearInterfaceItemsCache()

Clears the Interface Items Cache (clears the session).

cacheInterfaceItems()

Cache the interface items.

string
pagetabs(Page[] $tabs)

No description

string
tabs(Page[] $tabs, bool $jstabs = true, string $callback = 'ccm_activateTabBar')

No description

renderError(string $title, string $error, bool|Exception $exception = false)

No description

Response;
buildErrorResponse(string $title, string $error, bool|Exception $exception = false)

No description

string
notify(array $arguments)

No description

Details

string submit(string $text, bool|string $formID = false, string $buttonAlign = 'right', string $innerClass = null, array $args = array())

Generates a submit button in the Concrete style.

Parameters

string $text The text of the button
bool|string $formID The form this button will submit
string $buttonAlign
string $innerClass
array $args Extra args passed to the link

Return Value

string

string button(string $text, string $href, string $buttonAlign = 'right', string $innerClass = null, array $args = array())

Generates a simple link button in the Concrete style.

Parameters

string $text The text of the button
string $href
string $buttonAlign
string $innerClass
array $args Extra args passed to the link

Return Value

string

string buttonJs(string $text, string $onclick, string $buttonAlign = 'right', string $innerClass = null, array $args = array())

Generates a JavaScript function button in the Concrete style.

Parameters

string $text The text of the button
string $onclick
string $buttonAlign
string $innerClass
  • no longer used
array $args Extra args passed to the link

Return Value

string

button_js($text, $onclick, $buttonAlign = 'right', $innerClass = null, $args = array()) deprecated

deprecated

Parameters

$text
$onclick
$buttonAlign
$innerClass
$args

string buttons(string $buttons = null)

Outputs button text passed as arguments with a special Concrete wrapper for positioning $bh->buttons($myButton1, $myButton2, $myButton3); .

Parameters

string $buttons

Return Value

string

string getQuickNavigationLinkHTML(Page $c)

Parameters

Page $c

Return Value

string

bool showWhiteLabelMessage()

Return Value

bool

string getToolbarLogoSRC()

Return Value

string

bool showNewsflowOverlay()

Return Value

bool

bool showHelpOverlay()

Shall we show the introductive help overlay?

Return Value

bool

trackHelpOverlayDisplayed()

clearInterfaceItemsCache()

Clears the Interface Items Cache (clears the session).

cacheInterfaceItems()

Cache the interface items.

string pagetabs(Page[] $tabs)

Parameters

Page[] $tabs

Return Value

string

string tabs(Page[] $tabs, bool $jstabs = true, string $callback = 'ccm_activateTabBar')

Parameters

Page[] $tabs
bool $jstabs
string $callback

Return Value

string

renderError(string $title, string $error, bool|Exception $exception = false)

Parameters

string $title
string $error
bool|Exception $exception

Response; buildErrorResponse(string $title, string $error, bool|Exception $exception = false)

Parameters

string $title
string $error
bool|Exception $exception

Return Value

Response;

string notify(array $arguments)

Parameters

array $arguments

Return Value

string