GravityView  2.5
The best, easiest way to display Gravity Forms entries on your website.
Public Member Functions | Data Fields | Private Attributes
GravityView_Field_Other_Entries Class Reference

A field that displays other entries by the entry_creator for the same View in a list format. More...

Inheritance diagram for GravityView_Field_Other_Entries:
GravityView_Field

Public Member Functions

 __construct ()
 
 field_options ( $field_options, $template_id, $field_id, $context, $input_type, $form_id)
 
 filter_entries ( $search_criteria, $form_id=null, $args=array(), $force_search_criteria=false)
 
 get_entries ( $context)
 Retrieve the other entries based on the current View and entry. More...
 
 gf_query_filter (&$query, $view, $request)
 
- 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, $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

 $contexts = array( 'multiple', 'single' )
 
 $group = 'gravityview'
 
 $is_searchable = false
 
 $name = 'other_entries'
 
- 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
 

Private Attributes

 $context
 

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

A field that displays other entries by the entry_creator for the same View in a list format.

Since
1.7.2

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

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

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

References GV\description.

Member Function Documentation

◆ field_options()

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

Since
1.7.2

Definition at line 36 of file class-gravityview-field-other-entries.php.

References $context.

◆ filter_entries()

filter_entries (   $search_criteria,
  $form_id = null,
  $args = array(),
  $force_search_criteria = false 
)

Filter entries by approved and created_by.

Runs Filter:
gravityview/field/other_entries/criteria Modify the search parameters before the entries are fetched.
Since
1.11
Parameters
array$criteriaGravity Forms search criteria array, as used by GVCommon::get_entries()
array$view_settingsAssociative array of settings with plugin defaults used if not set by the View
int$form_idThe Gravity Forms ID
Since
2.0
Parameters
\GV\Template_Context$gravityviewThe context

Force mode all and filter out our own entry.

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

References $context, $created_by, and $criteria.

◆ get_entries()

get_entries (   $context)

Retrieve the other entries based on the current View and entry.

Parameters
\GV\Template_Context$contextThe context that contains the View and the Entry.
Returns
[] The entries.

Definition at line 95 of file class-gravityview-field-other-entries.php.

References $context, and $entries.

◆ gf_query_filter()

gf_query_filter ( $query,
  $view,
  $request 
)

Definition at line 181 of file class-gravityview-field-other-entries.php.

Field Documentation

◆ $context

$context
private

◆ $contexts

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

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

◆ $group

$group = 'gravityview'

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

◆ $is_searchable

$is_searchable = false

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

◆ $name

$name = 'other_entries'

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


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