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

Public Member Functions

 __construct ()
 GravityView_Field_Payment_Amount constructor. More...
 
 get_content ( $output='', $entry=array(), $field_settings=array(), $field=array())
 Filter the value of the field. More...
 
 get_value ( $value, $field, $view, $source, $entry, $request)
 Filter the value of the field, future. More...
 
 replace_merge_tag ( $matches=array(), $text='', $form=array(), $entry=array(), $url_encode=false, $esc_html=false)
 Add {payment_amount} merge tag. 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 = 'payment_amount'
 
 $group = 'pricing'
 
 $icon = 'dashicons-cart'
 
 $is_numeric = true
 
 $is_searchable = true
 
 $name = 'payment_amount'
 
 $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-payment-amount.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Member Function Documentation

◆ get_content()

get_content (   $output = '',
  $entry = array(),
  $field_settings = array(),
  $field = array() 
)

Filter the value of the field.

Since
1.16
Parameters
string$outputHTML value output
array$entryThe GF entry array
array$field_settingsSettings for the particular GV field
array$fieldCurrent field being displayed
Returns
String values for this field based on the numeric values used by Gravity Forms

Overridden by a template.

Definition at line 51 of file class-gravityview-field-payment-amount.php.

References $entry, $field, $output, and Utils\get().

Referenced by get_value().

◆ get_value()

get_value (   $value,
  $field,
  $view,
  $source,
  $entry,
  $request 
)

Filter the value of the field, future.

Since
2.0
Parameters
mixed$valueThe value of the field.
\GV\Field$fieldThe field as seen by future.
\GV\View$viewThe view requested in.
\GV\Source$sourceThe data source (form).
\GV\Entry$entryThe entry.
\GV\Request$requestThe request context.
Returns
mixed $value The filtered value.

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

References $entry, $field, $value, and get_content().

◆ replace_merge_tag()

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

Add {payment_amount} merge tag.

Since
1.16
Parameters
array$matchesArray of Merge Tag matches found in text by preg_match_all
string$textText to replace
array$formGravity Forms form array
array$entryEntry array
bool$url_encodeWhether to URL-encode output
Returns
string Original text if {date_created} isn't found. Otherwise, replaced text.

Definition at line 93 of file class-gravityview-field-payment-amount.php.

References $entry, and Utils\get().

Field Documentation

◆ $_custom_merge_tag

$_custom_merge_tag = 'payment_amount'

Definition at line 23 of file class-gravityview-field-payment-amount.php.

◆ $group

$group = 'pricing'

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

◆ $icon

$icon = 'dashicons-cart'

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

◆ $is_numeric

$is_numeric = true

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

◆ $is_searchable

$is_searchable = true

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

◆ $name

$name = 'payment_amount'

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

◆ $search_operators

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

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


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