GravityView  2.17
The best, easiest way to display Gravity Forms entries on your website.
Public Member Functions | Protected Attributes | Private Member Functions
GravityView_Widget_Poll Class Reference

Widget to add custom content. More...

Inheritance diagram for GravityView_Widget_Poll:
GravityView_Widget GravityView_Widget Widget Widget

Public Member Functions

 __construct ()
 
 add_template_path ( $file_paths)
 Include this extension templates path. More...
 
 get_frontend_settings ( $widget_settings)
 Get the display settings for the Poll widget. More...
 
 pre_render_frontend ()
 
 render_frontend ( $widget_args, $content='', $context='')
 Render the widget. More...
 
- Public Member Functions inherited from Widget
 add_shortcode ()
 Add $this->shortcode_name shortcode to output self::render_frontend() More...
 
 as_configuration ()
 Return an array of the old format. More...
 
 assign_widget_options ( $options=array(), $template='', $widget='')
 Assign template specific widget options. More...
 
 get_setting ( $key)
 Get a setting by the setting key. More...
 
 get_settings ()
 Get the widget settings. More...
 
 get_widget_id ()
 Get the Widget ID. More...
 
 is_registered ()
 Whether this Widget's been registered already or not. More...
 
 maybe_do_shortcode ( $text, $widget=null)
 Do shortcode if the Widget's shortcode exists. More...
 
 pre_render_frontend ()
 General validations when rendering the widget. More...
 
 register_widget ( $widgets)
 Register widget to become available in admin. More...
 
 render_frontend ( $widget_args, $content='', $context='')
 Frontend logic. More...
 
 render_shortcode ( $atts, $content='', $context='')
 Shortcode. More...
 

Protected Attributes

 $show_on_single = false
 
- Protected Attributes inherited from Widget
 $defaults = array()
 
 $settings = array()
 
 $shortcode_name
 
 $widget_description = ''
 
 $widget_id = ''
 
 $widget_label = ''
 
 $widget_subtitle = ''
 

Private Member Functions

 enqueue_scripts_and_styles ()
 Load the scripts and styles needed for the display of the poll widget. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Widget
static from_configuration ( $configuration)
 Create the needed widget from a configuration array. More...
 
static get_default_widget_areas ()
 Default widget areas. More...
 
static registered ()
 Return all registered widgets. More...
 
- Data Fields inherited from Widget
 $configuration
 
 $icon
 
 $position = ''
 
 $UID = ''
 
- Protected Member Functions inherited from Widget
 get_default_settings ()
 Define general widget settings. More...
 

Detailed Description

Widget to add custom content.

Since
1.8

Definition at line 10 of file class-gravityview-widget-poll.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )
Since
1.8

Definition at line 22 of file class-gravityview-widget-poll.php.

References Widget\$settings, and Widget\is_registered().

Member Function Documentation

◆ add_template_path()

add_template_path (   $file_paths)

Include this extension templates path.

Since
1.8
Parameters
array$file_pathsList of template paths ordered

Definition at line 73 of file class-gravityview-widget-poll.php.

◆ enqueue_scripts_and_styles()

enqueue_scripts_and_styles ( )
private

Load the scripts and styles needed for the display of the poll widget.

Since
1.8

Definition at line 88 of file class-gravityview-widget-poll.php.

Referenced by render_frontend().

◆ get_frontend_settings()

get_frontend_settings (   $widget_settings)

Get the display settings for the Poll widget.

Parameters
array$widget_settingsSettings for the Poll widget
Returns
array Final poll widget settings
Runs Filter:
gravityview/widget/poll/settings Modify display settings for the poll widget
Since
1.8
Parameters
array$settingsSettings with field, style, percentages and counts keys

Definition at line 140 of file class-gravityview-widget-poll.php.

References Widget\$settings.

Referenced by render_frontend().

◆ pre_render_frontend()

pre_render_frontend ( )

Since
1.8

Definition at line 104 of file class-gravityview-widget-poll.php.

References gravityview().

Referenced by render_frontend().

◆ render_frontend()

render_frontend (   $widget_args,
  $content = '',
  $context = '' 
)

Field Documentation

◆ $show_on_single

$show_on_single = false
protected

Definition at line 16 of file class-gravityview-widget-poll.php.


The documentation for this class was generated from the following file: