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

Add a sequence field. More...

Inheritance diagram for GravityView_Field_Sequence:
GravityView_Field

Public Member Functions

 __construct ()
 
 add_default_field ( $entry_default_fields, $form=array(), $zone='')
 Add as a default field, outside those set in the Gravity Form form. More...
 
 field_options ( $field_options, $template_id, $field_id, $context, $input_type, $form_id)
 
 field_tooltips ( $tooltips)
 Add tooltips. More...
 
 get_sequence ( $context)
 Calculate the current sequence number for the context. More...
 
 replace_merge_tag ( $matches=array(), $text='', $form=array(), $entry=array(), $url_encode=false, $esc_html=false)
 Replace {sequence} Merge Tags inside Custom Content fields. 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

 $_custom_merge_tag = 'sequence'
 
 $contexts = array( 'single', 'multiple' )
 
 $group = 'gravityview'
 
 $icon = 'dashicons-editor-ol'
 
 $is_numeric = true
 
 $is_searchable = false
 
 $is_sortable = false
 
 $name = 'sequence'
 
- 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 a sequence field.

Since
2.3.3

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

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

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

References GV\description.

Member Function Documentation

◆ add_default_field()

add_default_field (   $entry_default_fields,
  $form = array(),
  $zone = '' 
)

Add as a default field, outside those set in the Gravity Form form.

Since
2.10 Moved here from GravityView_Admin_Views::get_entry_default_fields
Parameters
array$entry_default_fieldsExisting fields
string | array$formform_ID or form object
string$zoneEither 'single', 'directory', 'edit', 'header', 'footer'
Returns
array

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

References GV\description.

◆ field_options()

field_options (   $field_options,
  $template_id,
  $field_id,
  $context,
  $input_type,
  $form_id 
)

Definition at line 96 of file class-gravityview-field-sequence.php.

◆ field_tooltips()

field_tooltips (   $tooltips)

Add tooltips.

Parameters
array$tooltipsExisting tooltips
Returns
array Modified tooltips

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

◆ get_sequence()

get_sequence (   $context)

Calculate the current sequence number for the context.

Parameters
\GV\Template_Context$contextThe context.
Returns
int The sequence number for the field/entry within the view results.

Figure out the starting number.

Definition at line 225 of file class-gravityview-field-sequence.php.

References $entry.

Referenced by replace_merge_tag().

◆ replace_merge_tag()

replace_merge_tag (   $matches = array(),
  $text = '',
  $form = array(),
  $entry = array(),
  $url_encode = false,
  $esc_html = false 
)

Replace {sequence} Merge Tags inside Custom Content fields.

TODO:

  • Find a better way to infer current View data (without using legacy code)
Parameters
array$matches
string$text
array$form
array$entry
bool$url_encode
bool$esc_html
Returns
string

An internal cache for sequence tag reuse within one field. Avoids calling get_sequence over and over again, off-by-many increments, etc.

We make sure that distinct sequence modifiers have their own output counters.

Definition at line 134 of file class-gravityview-field-sequence.php.

References $entry, $gv_field, Internal_Field\by_id(), View\by_id(), GF_Entry\from_entry(), Utils\get(), get_sequence(), GravityView_View\getInstance(), gravityview(), and gravityview_get_current_view_data().

Field Documentation

◆ $_custom_merge_tag

$_custom_merge_tag = 'sequence'

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

◆ $contexts

$contexts = array( 'single', 'multiple' )

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

◆ $group

$group = 'gravityview'

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

◆ $icon

$icon = 'dashicons-editor-ol'

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

◆ $is_numeric

$is_numeric = true

Definition at line 31 of file class-gravityview-field-sequence.php.

◆ $is_searchable

$is_searchable = false

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

◆ $is_sortable

$is_sortable = false

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

◆ $name

$name = 'sequence'

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


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