GravityView  2.17
The best, easiest way to display Gravity Forms entries on your website.
Public Member Functions | Data Fields
GravityView_Field_Total Class Reference
Inheritance diagram for GravityView_Field_Total:
GravityView_Field

Public Member Functions

 __construct ()
 
 add_to_blocklist ( $blocklist=array(), $context=NULL)
 Prevent the Total fields from being displayed in the Edit Entry configuration screen – for now. More...
 
 edit_entry_recalculate_totals ( $form=array(), $entry_id=0, $Edit_Entry_Render=null)
 If entry has totals fields, recalculate them. More...
 
- Public Member Functions inherited from GravityView_Field
 __construct ()
 GravityView_Field constructor. More...
 
 _filter_gform_custom_merge_tags ( $custom_merge_tags=array(), $form_id=0, $fields=array(), $element_id='')
 Add custom merge tags to merge tag options. More...
 
 _filter_gform_replace_merge_tags ( $text, $form=array(), $entry=array(), $url_encode=false, $esc_html=false)
 Match the merge tag in replacement text for the field. More...
 
 _filter_sortable_fields ( $not_sortable)
 Use field settings to modify whether a field is sortable. More...
 
 add_entry_meta ( $entry_meta)
 Add the custom entry meta key to make it searchable and sortable. More...
 
 add_field_support ( $key, &$field_options)
 
 add_sortable_field ( $fields)
 Add the field to the Filter & Sort available fields. More...
 
 as_array ()
 Returns the field as an array to be used in field pickers. More...
 
 field_options ( $field_options, $template_id, $field_id, $context, $input_type, $form_id)
 Tap in here to modify field options. More...
 
 replace_merge_tag ( $matches=array(), $text='', $form=array(), $entry=array(), $url_encode=false, $esc_html=false)
 Run GravityView filters when using GFCommon::replace_variables() More...
 
 set_default_search_label ( $label='', $gf_field=null, $field=array())
 Allow setting a default search label for search fields based on the field type. More...
 

Data Fields

 $_gf_field_class_name = 'GF_Field_Total'
 
 $group = 'product'
 
 $icon = 'dashicons-cart'
 
 $is_numeric = true
 
 $is_searchable = true
 
 $name = 'total'
 
 $search_operators = array( 'is', 'isnot', 'greater_than', 'less_than', 'contains' )
 
- Data Fields inherited from GravityView_Field
 $_gf_field_class_name
 
 $contexts = array( 'single', 'multiple', 'edit', 'export' )
 
 $default_search_label
 
 $description
 
 $entry_meta_is_default_column = false
 
 $entry_meta_key = null
 
 $entry_meta_update_callback = null
 
 $group
 standard, advanced, post, pricing, meta, gravityview, or add-ons More...
 
 $icon = 'dashicons-admin-generic'
 
 $is_numeric
 boolean Is field content number-based? More...
 
 $is_searchable = true
 
 $is_sortable = true
 boolean Can the field be sorted in search? More...
 
 $label
 
 $name
 
 $search_operators
 

Additional Inherited Members

- Protected Member Functions inherited from GravityView_Field
 custom_merge_tags ( $form=array(), $fields=array())
 Add custom Merge Tags to Merge Tag options, if custom Merge Tags exist. More...
 
 is_choice_value_enabled ()
 Check whether the enableChoiceValue flag is set for a GF field. More...
 
- Protected Attributes inherited from GravityView_Field
 $_custom_merge_tag = false
 
 $_field_id = ''
 
 $_field_options = array()
 

Detailed Description

Definition at line 9 of file class-gravityview-field-total.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Definition at line 26 of file class-gravityview-field-total.php.

Member Function Documentation

◆ add_to_blocklist()

add_to_blocklist (   $blocklist = array(),
  $context = NULL 
)

Prevent the Total fields from being displayed in the Edit Entry configuration screen – for now.

Gravity Forms forms need to know all the pricing information available to calculate a Total.

If you have an Edit Entry field with just two fields (Quantity and Total), the Total will not be able to calculate without the Product field, and possibly the Option, Shipping, and Coupon fields.

The only options currently available are: show the whole form, or don't show the Total

Since
1.20
Parameters
array$blocklistArray of field types not able to be added to Edit Entry
string | null$contextContext
Returns
array Blocklist, with "total" added. If not edit context, original field blocklist. Otherwise, blocklist including total.

Definition at line 55 of file class-gravityview-field-total.php.

◆ edit_entry_recalculate_totals()

edit_entry_recalculate_totals (   $form = array(),
  $entry_id = 0,
  $Edit_Entry_Render = null 
)

If entry has totals fields, recalculate them.

Since
1.20
Parameters
array$formGravity Forms form array
int$entry_idGravity Forms Entry ID
GravityView_Edit_Entry_Render$Edit_Entry_Render
Returns
void

GF_Field_Total $total_field

Definition at line 77 of file class-gravityview-field-total.php.

References $entry, GV\$form, and gravityview().

Field Documentation

◆ $_gf_field_class_name

$_gf_field_class_name = 'GF_Field_Total'
See also
GF_Field_Total

Definition at line 24 of file class-gravityview-field-total.php.

◆ $group

$group = 'product'

Definition at line 19 of file class-gravityview-field-total.php.

◆ $icon

$icon = 'dashicons-cart'

Definition at line 21 of file class-gravityview-field-total.php.

◆ $is_numeric

$is_numeric = true

Definition at line 15 of file class-gravityview-field-total.php.

◆ $is_searchable

$is_searchable = true

Definition at line 13 of file class-gravityview-field-total.php.

◆ $name

$name = 'total'

Definition at line 11 of file class-gravityview-field-total.php.

◆ $search_operators

$search_operators = array( 'is', 'isnot', 'greater_than', 'less_than', 'contains' )

Definition at line 17 of file class-gravityview-field-total.php.


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