GravityView  2.17
The best, easiest way to display Gravity Forms entries on your website.
Public Member Functions | Static Public Member Functions | Data Fields
GravityView_Field_List Class Reference

Add custom options for list fields. More...

Inheritance diagram for GravityView_Field_List:
GravityView_Field

Public Member Functions

 __construct ()
 
 _filter_field_label ( $label, $field, $form, $entry)
 When showing a single column values, display the label of the column instead of the field. More...
 
 add_form_fields ( $fields=array(), $form=array(), $include_parent_field=true)
 If a form has list fields, add the columns to the field picker. More...
 
 remove_columns_from_searchable_fields ( $fields)
 Removes columns from searchable field dropdown. 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...
 

Static Public Member Functions

static column_value (GF_Field_List $field, $field_value, $column_id=0, $format='html')
 Get the value of a Multiple Column List field for a specific column. More...
 
static get_column_label (GF_Field_List $field, $column_id, $backup_label='')
 Get the column label for the list. More...
 

Data Fields

 $_gf_field_class_name = 'GF_Field_List'
 
 $group = 'advanced'
 
 $icon = 'dashicons-list-view'
 
 $is_searchable = true
 
 $is_sortable = false
 
 $name = 'list'
 
 $search_operators = array( '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

Add custom options for list fields.

Since
1.14

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

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Definition at line 39 of file class-gravityview-field-list.php.

Member Function Documentation

◆ _filter_field_label()

_filter_field_label (   $label,
  $field,
  $form,
  $entry 
)

When showing a single column values, display the label of the column instead of the field.

Since
1.14
Parameters
string$labelExisting label string
array$fieldGV field settings array, with id, show_label, label, custom_label, etc. keys
array$formGravity Forms form array
array$entryGravity Forms entry array
Returns
string Existing label if the field isn't

Definition at line 189 of file class-gravityview-field-list.php.

References $column_id, $field, GV\$form, GravityView_Field\$label, and gravityview_get_input_id_from_id().

◆ add_form_fields()

add_form_fields (   $fields = array(),
  $form = array(),
  $include_parent_field = true 
)

If a form has list fields, add the columns to the field picker.

Since
1.17
Parameters
array$fieldsAssociative array of fields, with keys as field type
array$formGF Form array
bool$include_parent_fieldWhether to include the parent field when getting a field with inputs
Returns
array $fields with list field columns added, if exist. Unmodified if form has no list fields.

Merge the $list_columns into the $fields array at $index

See also
https://stackoverflow.com/a/1783125

Definition at line 84 of file class-gravityview-field-list.php.

References GV\$form, and $input_id.

◆ column_value()

static column_value ( GF_Field_List  $field,
  $field_value,
  $column_id = 0,
  $format = 'html' 
)
static

Get the value of a Multiple Column List field for a specific column.

Since
1.14
See also
GF_Field_List::get_value_entry_detail()
Parameters
GF_Field_List$fieldGravity Forms field
string | array$field_valueSerialized or unserialized array value for the field
int | string$column_idThe numeric key of the column (0-index) or the label of the column
string$formatIf set to 'raw', return an array of values for the column. Otherwise, allow Gravity Forms to render using html or text
Returns
array|string|null Returns null if the $field_value passed wasn't an array or serialized array

Definition at line 143 of file class-gravityview-field-list.php.

References $column_id, $field_value, $format, and gravityview().

◆ get_column_label()

static get_column_label ( GF_Field_List  $field,
  $column_id,
  $backup_label = '' 
)
static

Get the column label for the list.

Since
1.14
Parameters
GF_Field_List$fieldGravity Forms List field
int$column_idThe key of the column (0-index)
string$backup_labelBackup label to use. Optional.
Returns
string

Definition at line 224 of file class-gravityview-field-list.php.

References $column_id.

◆ remove_columns_from_searchable_fields()

remove_columns_from_searchable_fields (   $fields)

Removes columns from searchable field dropdown.

Columns are able to be added to View layouts, but not separately searched!

Parameters
array$fields
int$form_id
Returns
array

Definition at line 62 of file class-gravityview-field-list.php.

References $field.

Field Documentation

◆ $_gf_field_class_name

$_gf_field_class_name = 'GF_Field_List'
See also
GF_Field_List

Definition at line 33 of file class-gravityview-field-list.php.

◆ $group

$group = 'advanced'

Definition at line 35 of file class-gravityview-field-list.php.

◆ $icon

$icon = 'dashicons-list-view'

Definition at line 37 of file class-gravityview-field-list.php.

◆ $is_searchable

$is_searchable = true

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

◆ $is_sortable

$is_sortable = false

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

◆ $name

$name = 'list'

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

◆ $search_operators

$search_operators = array( 'contains' )

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


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