Class WidgetClient

Simplifies the creation of widgets for the client interface

Html

WidgetClient

Package: blesta\helpers\widget\client
Copyright: Copyright (c) 2010, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at helpers/widget_client/widget_client.php

Methods summary

`public`	# `clear( )` Clear this widget, making it ready to produce the next widget Clear this widget, making it ready to produce the next widget
`public`	# `setLinks( array $link, mixed $type = "links" )` Sets navigation links within the widget Sets navigation links within the widget Parameters `$link` `array` $tabs A multi-dimensional array of tab info including: - name The name of the link to be displayed - current True if this element is currently active - attributes An array of attributes to set for this tab (e.g. array('href'=>"#")) `$type`
`public`	# `setLinkButtons( array $link_buttons )` Sets navigation buttons along with Widget::setLinks(). This method may only be used in addition with Widget::setLinks() Sets navigation buttons along with Widget::setLinks(). This method may only be used in addition with Widget::setLinks() Parameters `$link_buttons` `array` $link_buttons A multi-dimensional array of button links including: - name The name of the button link to be displayed - attributes An array of attributes to set for this button link (e.g. array('href'=>"#"))
`public`	# `setWidgetButton( mixed $button )` Set a widget button to be displayed in the title bar of the widget Set a widget button to be displayed in the title bar of the widget
`public`	# `setStyleSheet( string $path, array $attributes = null )` Sets a style sheet to be linked into the document Sets a style sheet to be linked into the document Parameters `$path` `string` $path the web path to the style sheet `$attributes` `array` An array of attributes to set for this element
`public`	# `renderSubHead( boolean $render )` Sets whether or not the sub heading section should be rendered Sets whether or not the sub heading section should be rendered Deprecated since 3.2 Parameters `$render` `boolean` $render True to render the sub heading, false otherwise
`public`	# `autoStartBody( boolean $auto_start )` Sets whether or not the body panel should start when WidgetClient::create() is called Sets whether or not the body panel should start when WidgetClient::create() is called Parameters `$auto_start` `boolean` $auto_start True to auto begin the widget body when WidgetClient::create() is called
`public mixed`	# `create( string $title = null, array $attributes = null, string $render = null )` Creates the widget with the given title and attributes Creates the widget with the given title and attributes Parameters `$title` `string` $title The title to display for this widget `$attributes` `array` $attributes An list of attributes to set for this widget's primary container `$render` `string` $render How to render the widget. Options include: - full The entire widget (default) - inner_content (everthing but the title) Returns `mixed` An HTML string containing the widget, void if the string is output automatically
`public mixed`	# `end( )` End the widget, closing an loose ends End the widget, closing an loose ends Returns `mixed` An HTML string ending the widget, void if the string is output automatically
`public mixed`	# `startBody( boolean $output = true )` Start the widget body Start the widget body Parameters `$output` `boolean` $output True to output the body, false to return it Returns `mixed` An HTML string beginning the widget body, void if the string is output automatically
`public mixed`	# `endBody( boolean $output = true )` End the widget body End the widget body Parameters `$output` `boolean` $output True to output the body, false to return it Returns `mixed` An HTML string ending the widget body, void if the string is output automatically
`public mixed`	# `startFooter( boolean $output = true )` Start the widget footer Start the widget footer Parameters `$output` `boolean` $output True to output the footer, false to return it Returns `mixed` An HTML string beginning the widget footer, void if the string is output automatically
`public mixed`	# `endFooter( boolean $output = true )` End the widget footer End the widget footer Parameters `$output` `boolean` $output True to output the footer, false to return it Returns `mixed` An HTML string ending the widget footer, void if the string is output automatically
`public`	# `setOutput( boolean $return )` Set whether to return $output generated by these methods, or to echo it out instead Set whether to return $output generated by these methods, or to echo it out instead Parameters `$return` `boolean` $return True to return output from these widget methods, false to echo results instead

Methods inherited from Html

_(), addCondition(), buildAttributes(), concat(), hyperlink(), ifSet(), isUtf8(), safe()

Magic methods summary

Properties summary

Properties inherited from Html

$xhtml

Packages

Classes

Class WidgetClient

Methods summary

Parameters

Parameters

Parameters

Deprecated

Parameters

Parameters

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Methods inherited from Html

Magic methods summary

Properties summary

Properties inherited from Html