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

Public Member Functions

 __construct ()
 
 add_default_field ( $entry_default_fields, $form, $zone)
 
 field_options ( $field_options, $template_id, $field_id, $context, $input_type, $form_id)
 
- 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...
 
 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 get_output ( $approval_status='', $field_settings=array(), $html=false)
 Convert entry approval status value to label in the field output. More...
 

Data Fields

 $_custom_merge_tag = 'approval_status'
 
 $contexts = array( 'single', 'multiple' )
 
 $entry_meta_is_default_column = false
 
 $entry_meta_key = 'is_approved'
 
 $group = 'meta'
 
 $icon = 'dashicons-yes-alt'
 
 $is_numeric = true
 
 $is_searchable = true
 
 $is_sortable = true
 
 $name = 'is_approved'
 
 $search_operators = array( 'is', 'isnot' )
 
- 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
 
 $is_searchable = true
 
 $is_sortable = true
 
 $label
 
 $name
 
 $search_operators
 

Protected Member Functions

 custom_merge_tags ( $form=array(), $fields=array())
 Add custom merge tags to merge tag options. More...
 
- 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...
 

Private Member Functions

 add_hooks ()
 

Additional Inherited Members

- Protected Attributes inherited from GravityView_Field
 $_custom_merge_tag = false
 
 $_field_id = ''
 
 $_field_options = array()
 

Detailed Description

Definition at line 8 of file class-gravityview-field-is-approved.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Definition at line 40 of file class-gravityview-field-is-approved.php.

References add_hooks(), and GV\description.

Member Function Documentation

◆ add_default_field()

add_default_field (   $entry_default_fields,
  $form,
  $zone 
)
Runs Filter:
gravityview_entry_default_fields
Parameters
array$entry_default_fieldsArray of fields shown by default
string | array$formform_ID or form object
string$zoneEither 'single', 'directory', 'header', 'footer'
Returns
array

Definition at line 98 of file class-gravityview-field-is-approved.php.

References $name, and GV\description.

◆ add_hooks()

add_hooks ( )
private

Definition at line 51 of file class-gravityview-field-is-approved.php.

Referenced by __construct().

◆ custom_merge_tags()

custom_merge_tags (   $form = array(),
  $fields = array() 
)
protected

Add custom merge tags to merge tag options.

Since
1.16
Parameters
array$formGF Form array
GF_Field[]$fields Array of fields in the form
Returns
array Modified merge tags

Definition at line 121 of file class-gravityview-field-is-approved.php.

References $entry, GV\$form, GravityView_Entry_Approval\get_entry_status(), gravityview(), and GravityView_Field\replace_merge_tag().

◆ field_options()

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

◆ get_output()

static get_output (   $approval_status = '',
  $field_settings = array(),
  $html = false 
)
static

Convert entry approval status value to label in the field output.

Uses labels from the field setting.

Since
2.10
Parameters
string$approval_statusStatus to pass to {
See also
GravityView_Entry_Approval_Status::maybe_convert_status}
Parameters
bool$htmlWhether to return HTML or plaintext string value
Returns
string The field setting label for the current status. Uses defaults, if not configured.

Definition at line 65 of file class-gravityview-field-is-approved.php.

References $field_settings, $value, Utils\get(), GravityView_Entry_Approval_Status\get_key(), GravityView_Entry_Approval_Status\get_label(), and GravityView_Entry_Approval_Status\maybe_convert_status().

Field Documentation

◆ $_custom_merge_tag

$_custom_merge_tag = 'approval_status'

Definition at line 36 of file class-gravityview-field-is-approved.php.

◆ $contexts

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

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

◆ $entry_meta_is_default_column

$entry_meta_is_default_column = false

Definition at line 34 of file class-gravityview-field-is-approved.php.

◆ $entry_meta_key

$entry_meta_key = 'is_approved'

Definition at line 28 of file class-gravityview-field-is-approved.php.

◆ $group

$group = 'meta'

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

◆ $icon

$icon = 'dashicons-yes-alt'

Definition at line 38 of file class-gravityview-field-is-approved.php.

◆ $is_numeric

$is_numeric = true

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

◆ $is_searchable

$is_searchable = true

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

◆ $is_sortable

$is_sortable = true

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

◆ $name

$name = 'is_approved'

Definition at line 10 of file class-gravityview-field-is-approved.php.

Referenced by add_default_field().

◆ $search_operators

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

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


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