Class AbstractWidget

Abstract Widget

Html

Blesta\Core\Util\Widgets\AbstractWidget

Direct known subclasses

Abstract
Namespace: Blesta\Core\Util\Widgets
Package: blesta\core\Util\Widgets
Copyright: Copyright (c) 2020, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at core/Util/Widgets/AbstractWidget.php

Methods summary
`public`	# `setLinks( array $link, string $type = 'links' )` Sets navigation links within the widget Sets navigation links within the widget Parameters `$link` 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 link (e.g. array('href'=>"#")) `$type` the type of links being set (optional) (links or tabs, default links)
`public`	# `setLinkButtons( array $link_buttons )` Sets navigation buttons along with AbstractWidget::setLinks(). This method may only be used in addition with AbstractWidget::setLinks() Sets navigation buttons along with AbstractWidget::setLinks(). This method may only be used in addition with AbstractWidget::setLinks() Parameters `$link_buttons` A multi-dimensional array of button links including: name The name of the button link to be displayed icon The class name of the icon to display before the name attributes An array of attributes to set for this button link (e.g. array('href'=>"#"))
`public`	# `setWidgetButton( string\|array $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 Parameters `$button` The widget button attributes
`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` the web path to the style sheet `$attributes` array of attributes to set for this element
`public`	# `setFilters( Blesta\Core\Util\Input\Fields\InputFields $filters, string $uri, boolean $show_filters = false )` Sets a list of widget filters Sets a list of widget filters Parameters `$filters` A list of input fields to display in the widget filtering form `$uri` The uri for the widget filtering form action `$show_filters` Whether to show the filtering form on page load
`public`	# `setFilterHtml( string $html, boolean $show_filters = false )` Sets HTML for the widget filtering form Sets HTML for the widget filtering form Parameters `$html` The uri for the widget filtering form action `$show_filters` Whether to show the filtering form on page load
`public`	# `setHeaderLink( string $link )` Sets the link for the widget header Sets the link for the widget header Parameters `$link` The link for the widget header
`public`	# `setAjaxFiltering( boolean $ajax = true )` Sets whether to submit filters and reload widget via ajax Sets whether to submit filters and reload widget via ajax Parameters `$ajax` Whether to submit filters and reload widget via ajax
`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` True to return output from these widget methods, false to echo results instead
`protected string`	# `output( string $html )` Handles whether to output or return $html Handles whether to output or return $html Parameters `$html` The HTML to output/return Returns string The HTML given, void if output enabled
`protected`	# `setFilterLink( )` Add the filter form toggle button to the list of widget links Add the filter form toggle button to the list of widget links

Properties summary
`protected 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	# `"\n"`
`protected boolean`	`$return_output` Whether or not to return output from various widget methods Whether or not to return output from various widget methods	# `false`
`protected array`	`$widget_buttons` Buttons that should be displayed within the window Buttons that should be displayed within the window	# `[]`
`protected 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	# `[]`
`protected string`	`$render` How to render the widget. Options include: full The entire widget (default) inner The content only (everything excluding the nav and title) 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) - inner The content only (everything excluding the nav and title) - 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)	#
`protected array`	`$nav` $nav An array of navigation elements $nav An array of navigation elements	# `[]`
`protected string`	`$nav_type` $nav_type Sets the navigation type: links tabs pills $nav_type Sets the navigation type: - links - tabs - pills	# `'links'`
`protected array`	`$link_buttons` $link_buttons An array of link buttons $link_buttons An array of link buttons	# `[]`
`protected InputFilters`	`$filters` A list of input fields to display in the widget filtering form A list of input fields to display in the widget filtering form	#
`protected boolean`	`$show_filters` Whether to show the filter content on page load Whether to show the filter content on page load	#
`protected boolean`	`$ajax_filtering` Whether to submit filters and reload widget via ajax Whether to submit filters and reload widget via ajax	#
`protected string`	`$filter_html` The HTML to display either in or as the widget filtering form The HTML to display either in or as the widget filtering form	# `''`
`protected string`	`$filter_uri` The uri to which the widget filtering form should be submitted The uri to which the widget filtering form should be submitted	# `''`
`protected string`	`$header_link` The widget header link The widget header link	# `''`

Packages

Classes

Class AbstractWidget

Direct known subclasses

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns