State_summary_Widget Class Reference

Intent: visualize a filter's summarized state Input: any saved filter, whose table is configured in $states_per_table Output: decorated stats for the saved filter. More...

Inheritance diagram for State_summary_Widget:
widget_Base

Public Member Functions

 __construct (Widget_Model $widget_model)
 get_metadata ()
 Return the default friendly name for the widget type default to the model name, but should be overridden by widgets.
 options ()
 Return the list of options to use in this widget.
 get_filtered_data ($filter_id)
 index ()
 Print the widget contents here.

Protected Member Functions

 get_suggested_title ()
 The backwards compatible way to get widget default title.

Detailed Description

Intent: visualize a filter's summarized state Input: any saved filter, whose table is configured in $states_per_table Output: decorated stats for the saved filter.


Constructor & Destructor Documentation

State_summary_Widget::__construct ( Widget_Model widget_model  ) 
Parameters:
$widget_model Widget_Model

Reimplemented from widget_Base.


Member Function Documentation

State_summary_Widget::get_filtered_data ( filter_id  ) 
Parameters:
$filter_id int
Returns:
array
State_summary_Widget::get_metadata (  ) 

Return the default friendly name for the widget type default to the model name, but should be overridden by widgets.

Returns:
array

Reimplemented from widget_Base.

State_summary_Widget::get_suggested_title (  )  [protected]

The backwards compatible way to get widget default title.

Returns:
string

Reimplemented from widget_Base.

State_summary_Widget::index (  ) 

Print the widget contents here.

Concrete widgets typically want to override this.

Reimplemented from widget_Base.

State_summary_Widget::options (  ) 

Return the list of options to use in this widget.

This should be an array of option instances, or - if you want to do more manual work - strings.

Actual widgets typically want to extend this method.

Returns:
array of option

Reimplemented from widget_Base.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables

Generated on 19 Dec 2018 for ninja by  doxygen 1.6.1