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

Public Member Functions

 __construct ()
 
 clear_product_info_cache ( $form=array(), $entry_id=0, $Edit_Entry_Render=null)
 If the edited entry has a product field and the fields are shown, remove entry purchase cache. More...
 
 edit_entry_field_blacklist ( $blacklist=array(), $entry=array())
 Maybe add Product fields to the Edit Entry blacklist. More...
 
 should_hide_product_fields ( $entry=array())
 In Edit Entry, should Product fields be hidden? If entry has transaction data, they should be. More...
 
- Public Member Functions inherited from GravityView_Field
 __construct ()
 GravityView_Field constructor. More...
 
 _filter_gform_custom_merge_tags ( $custom_merge_tags=array(), $form_id, $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...
 
 field_options ( $field_options, $template_id, $field_id, $context, $input_type)
 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_Product'
 
 $group = 'product'
 
 $is_numeric = false
 
 $is_searchable = true
 
 $name = 'product'
 
 $search_operators = array( 'is', 'isnot', '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 More...
 
 $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

Since
1.20

Definition at line 12 of file class-gravityview-field-product.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )
Since
1.20

Definition at line 30 of file class-gravityview-field-product.php.

Member Function Documentation

◆ clear_product_info_cache()

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

If the edited entry has a product field and the fields are shown, remove entry purchase cache.

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

Definition at line 50 of file class-gravityview-field-product.php.

References $form, GVCommon\has_product_field(), and should_hide_product_fields().

◆ edit_entry_field_blacklist()

edit_entry_field_blacklist (   $blacklist = array(),
  $entry = array() 
)

Maybe add Product fields to the Edit Entry blacklist.

Since
1.20
Parameters
array$blacklistArray of field types not to be shown in the Edit Entry form
array$entryGravity Forms entry array
Returns
array Blacklist with product field types added, if should not be shown

Definition at line 76 of file class-gravityview-field-product.php.

References $entry, GVCommon\get_product_field_types(), and should_hide_product_fields().

◆ should_hide_product_fields()

should_hide_product_fields (   $entry = array())

In Edit Entry, should Product fields be hidden? If entry has transaction data, they should be.

Otherwise, no.

Since
1.20
Parameters
array$entryCurrent Gravity Forms entry being edited
Returns
bool True: hide product fields; False: show product fields
Runs Filter:
gravityview/edit_entry/hide-product-fields Hide product fields from being editable
Since
1.9.1
1.20 Changed default from false to whether or not entry has transaction data
See also
GVCommon::entry_has_transaction_data()
Parameters
boolean$hide_product_fieldsWhether to hide product fields in the editor. Uses $entry data to determine.

Definition at line 94 of file class-gravityview-field-product.php.

References $entry, and GVCommon\entry_has_transaction_data().

Referenced by clear_product_info_cache(), and edit_entry_field_blacklist().

Field Documentation

◆ $_gf_field_class_name

$_gf_field_class_name = 'GF_Field_Product'
See also
GF_Field_Product

Definition at line 25 of file class-gravityview-field-product.php.

◆ $group

$group = 'product'

Definition at line 22 of file class-gravityview-field-product.php.

◆ $is_numeric

$is_numeric = false

Definition at line 18 of file class-gravityview-field-product.php.

◆ $is_searchable

$is_searchable = true

Definition at line 16 of file class-gravityview-field-product.php.

◆ $name

$name = 'product'

Definition at line 14 of file class-gravityview-field-product.php.

◆ $search_operators

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

Definition at line 20 of file class-gravityview-field-product.php.


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