Class WidgetClient
Provides helper methods for dealing with HTML content
-
Html
-
WidgetClient
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 )
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'=>"#"))
|
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
|
#
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
Parameters
- $render
boolean
$render True to render the sub heading, false otherwise
|
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) -inner The content only
(everything excluding the nav and 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
|
private
mixed
|
#
buildNav( )
Builds the nav for this widget
Builds the nav for this widget
Returns
mixed
A string of HTML, or void if HTML is output automatically
|
private
string
|
#
buildNavElements( )
Builds the nav elements for this widget
Builds the nav elements for this widget
Returns
string
A string of HTML
|
private
string
|
#
buildLinkButtons( array $attributes = null )
Builds link buttons for use with link navigation
Builds link buttons for use with link navigation
Returns
string
A string of HTML
|
private
string
|
#
buildStyleSheets( )
Builds the markup to link style sheets into the DOM using jQuery
Builds the markup to link style sheets into the DOM using jQuery
Returns
string
A string of HTML
|
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
|
private
string
|
#
output( string $html )
Handles whether to output or return $html
Handles whether to output or return $html
Parameters
- $html
string
$html The HTML to output/return Returns
string
The HTML given, void if output enabled
|
Methods inherited from Html
_(),
addCondition(),
buildAttributes(),
concat(),
hyperlink(),
ifSet(),
isUtf8(),
safe()
Magic methods summary
Properties summary
private
string
|
$eol |
#
The string to use as the end of line character, "\n" by default
The string to use as the end of line character, "\n" by default
|
private
boolean
|
$return_output |
#
Whether or not to return output from various widget methods
Whether or not to return output from various widget methods
|
private
array
|
$widget_buttons |
#
Buttons that should be displayed within the window
Buttons that should be displayed within the window
|
private
array
|
$style_sheets |
#
An array of style sheet attributes to be rendered into the DOM
An array of style sheet attributes to be rendered into the DOM
|
private
string
|
$render |
#
How to render the widget. Options include:
-full The entire widget (default)
-inner The content only (everything excluding the nav and title)
How to render the widget. Options include: -full The entire widget (default)
-inner The content only (everything excluding the nav and title)
|
private
boolean
|
$sub_head |
#
Controls whether or not to render the sub heading section
Controls whether or not to render the sub heading section
|
private
mixed
|
$nav |
|
private
string
|
$nav_type |
|
private
mixed
|
$link_buttons |
|
Properties inherited from Html
$xhtml