Class Widget

Provides helper methods for dealing with HTML content

Html

Extended by

Widget

Package: minPHP\helpers\html
Copyright: Copyright (c) 2010, Phillips Data, Inc.
License: The Blesta License Agreement
Located at helpers/widget/widget.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`	# `setTabs( array $tabs )` Sets navigation tabs within the widget Sets navigation tabs within the widget Parameters `$tabs` `array` $tabs A multi-dimensional array of tab info including: -name The name of the tab 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`	# `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`	# `setBadgeUri( string $uri )` Sets the URI to request when fetching a badge value for this widget Sets the URI to request when fetching a badge value for this widget Parameters `$uri` `string` $uri The URI to request for the badge value for this widget
`public`	# `setBadgeValue( string $value = null )` Sets the badge value to appear on this widget, any thing other than null will be displayed Sets the badge value to appear on this widget, any thing other than null will be displayed Parameters `$value` `string` $value The value of the badge to be displayed
`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 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 -content_section The full content including nav (everything excluding box frame and title section) -common_box_content The content only (full_content excluding the nav) Returns `mixed` An HTML string containing the widget, void if the string is output automatically
`public mixed`	# `setRow( string $left = null, string $right = null )` Sets a row for this widget to be displayed. Sets a row for this widget to be displayed. Parameters `$left` `string` $left An HTML string to set on the left of the row `$right` `string` $right An HTML string to set on the right of the row Returns `mixed` An HTML string containing the row, 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 string`	# `buildWidgetButtons( )` Creates the window buttons that appear in the title bar of the widget Creates the window buttons that appear in the title bar of the widget Returns `string` An HTML string containing the window buttons
`private string`	# `buildBadge( )` Creates the badge value to appear next to the title of the widget Creates the badge value to appear next to the title of the widget Returns `string` An HTML string containing the badge value
`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( )` 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 string`	`$badge_uri`	# The URI to fetch when requesting the badge value for this widget The URI to fetch when requesting the badge value for this widget
`private string`	`$badge_value`	# The badge value to display for this widget The badge value to display for this widget
`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) -content_section The full content including nav (everything exluding box frame and title section) -common_box_content The content only (full_content excluding the nav) How to render the widget. Options include: -full The entire widget (default) -content_section The full content including nav (everything exluding box frame and title section) -common_box_content The content only (full_content excluding the nav)
`private mixed`	`$nav`	#
`private string`	`$nav_type`	#
`private mixed`	`$link_buttons`	#

Properties inherited from Html