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

Extend this class to create a GravityView extension that gets updates from GravityView.co. More...

Public Member Functions

 __construct ()
 
 add_hooks ()
 Extensions should override this hook to add their hooks instead of. More...
 
 add_metabox_tab ()
 If Extension overrides tab_settings() and passes its own tab, add it to the tabbed settings metabox. More...
 
 admin_notice ()
 Outputs the admin notices generated by the plugin. More...
 
 load_plugin_textdomain ()
 Load translations for the extension. More...
 
 save_post ($post_id)
 Store the filter settings in the _gravityview_filters post meta. More...
 
 settings ()
 Register the updater for the Extension using GravityView license information. More...
 
 tooltips ($tooltips=array())
 Add tooltips for the extension. More...
 

Static Public Member Functions

static add_notice ($notice=array())
 Add a notice to be displayed in the admin. More...
 

Static Public Attributes

static $is_compatible = true
 

Protected Member Functions

 get_license ()
 Get license information from GravityView. More...
 
 is_extension_supported ()
 Check whether the extension is supported: More...
 
 tab_settings ()
 Add a tab to GravityView Edit View tabbed metabox. More...
 

Protected Attributes

 $_author = 'Katz Web Services, Inc.'
 
 $_item_id = NULL
 
 $_min_gravityview_version = '1.1.5'
 
 $_min_php_version = '5.2.4'
 
 $_remote_update_url = 'https://gravityview.co'
 
 $_text_domain = 'gravityview'
 
 $_title = NULL
 
 $_version = NULL
 

Static Private Attributes

static $admin_notices = array()
 

Detailed Description

Extend this class to create a GravityView extension that gets updates from GravityView.co.

Since
1.1
Version
1.1.2 Fixed /lib/ include path for EDDSL

Definition at line 17 of file class-gravityview-extension.php.

Constructor & Destructor Documentation

__construct ( )

Definition at line 70 of file class-gravityview-extension.php.

References add_hooks(), and is_extension_supported().

Member Function Documentation

add_hooks ( )

Extensions should override this hook to add their hooks instead of.

Definition at line 300 of file class-gravityview-extension.php.

Referenced by __construct().

add_metabox_tab ( )

If Extension overrides tab_settings() and passes its own tab, add it to the tabbed settings metabox.

Since
1.8 (Extension version 1.0.7)
Returns
void

Definition at line 114 of file class-gravityview-extension.php.

References GravityView_Metabox_Tabs\add(), and tab_settings().

static add_notice (   $notice = array())
static

Add a notice to be displayed in the admin.

Parameters
array$noticeArray with class and message keys. The message is not escaped.

Definition at line 283 of file class-gravityview-extension.php.

admin_notice ( )

Outputs the admin notices generated by the plugin.

Returns
void

Definition at line 261 of file class-gravityview-extension.php.

get_license ( )
protected

Get license information from GravityView.

Since
1.8 (Extension version 1.0.7)
Returns
bool|array False: GravityView_Settings class does not exist. Array: array of GV license data.

Definition at line 203 of file class-gravityview-extension.php.

References getSetting().

Referenced by settings().

is_extension_supported ( )
protected

Check whether the extension is supported:

  • Checks if GravityView and Gravity Forms exist
  • Checks GravityView and Gravity Forms version numbers
  • Checks PHP version numbers
  • Sets self::$is_compatible to boolean value

GravityView_Admin::check_gravityforms()

Returns
boolean Is the extension supported?

Definition at line 343 of file class-gravityview-extension.php.

References GravityView_Compatibility\is_valid(), and GravityView_Plugin\version.

Referenced by __construct().

load_plugin_textdomain ( )

Load translations for the extension.

  1. Check wp-content/languages/gravityview/ folder and load using load_textdomain()
  2. Check wp-content/plugins/gravityview/languages/ folder for gravityview-[locale].mo file and load using load_textdomain()
  3. Load default file using load_plugin_textdomain() from wp-content/plugins/gravityview/languages/
Returns
void

Definition at line 161 of file class-gravityview-extension.php.

save_post (   $post_id)

Store the filter settings in the _gravityview_filters post meta.

Parameters
int$post_idPost ID
Returns
void

Definition at line 307 of file class-gravityview-extension.php.

settings ( )

Register the updater for the Extension using GravityView license information.

Returns
void

Definition at line 219 of file class-gravityview-extension.php.

References get_license().

tab_settings ( )
protected

Add a tab to GravityView Edit View tabbed metabox.

By overriding this method, you will add a tab to View settings

Since
1.8 (Extension version 1.0.7)
See also
https://gist.github.com/zackkatz/6cc381bcf54849f2ed41 For example of adding a metabox
Returns
array Array of metabox

Definition at line 102 of file class-gravityview-extension.php.

Referenced by add_metabox_tab().

tooltips (   $tooltips = array())

Add tooltips for the extension.

Add a tooltip with an array using the title and value keys. The title key is the H6 tag value of the tooltip; it's the headline. The value is the tooltip content, and can contain any HTML.

The tooltip key must be gv_{name_of_setting}. If the name of the setting is "example_extension_setting", the code would be:

$tooltips['gv_example_extension_setting'] = array( 'title' => 'About Example Extension Setting', 'value' => 'When you do [x] with [y], [z] happens.' );

Parameters
array$tooltipsExisting GV tooltips, with title and value keys
Returns
array Modified tooltips

Definition at line 326 of file class-gravityview-extension.php.

Field Documentation

$_author = 'Katz Web Services, Inc.'
protected

Definition at line 58 of file class-gravityview-extension.php.

$_item_id = NULL
protected

Definition at line 33 of file class-gravityview-extension.php.

$_min_gravityview_version = '1.1.5'
protected

Definition at line 43 of file class-gravityview-extension.php.

$_min_php_version = '5.2.4'
protected

Definition at line 48 of file class-gravityview-extension.php.

$_remote_update_url = 'https://gravityview.co'
protected

Definition at line 53 of file class-gravityview-extension.php.

$_text_domain = 'gravityview'
protected

Definition at line 38 of file class-gravityview-extension.php.

$_title = NULL
protected

Definition at line 22 of file class-gravityview-extension.php.

$_version = NULL
protected

Definition at line 27 of file class-gravityview-extension.php.

$admin_notices = array()
staticprivate

Definition at line 63 of file class-gravityview-extension.php.

$is_compatible = true
static

Definition at line 68 of file class-gravityview-extension.php.


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