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

If this file is called directly, abort. More...

Inheritance diagram for Internal_Field:
Field

Public Member Functions

 get_label (View $view=null, Source $source=null, Entry $entry=null, Request $request=null)
 Retrieve the label for this field. More...
 
 get_value (View $view=null, Source $source=null, Entry $entry=null, Request $request=null)
 Retrieve the value for this field. More...
 
- Public Member Functions inherited from Field
 __get ( $key)
 Get one of the extra configuration keys via property accessors. More...
 
 __isset ( $key)
 Is this set? More...
 
 as_configuration ()
 Return an array of the old format as used by callers of GVCommon:get_directory_fields() for example. More...
 
 get_label (View $view=null, Source $source=null, Entry $entry=null, Request $request=null)
 Retrieve the label for this field. More...
 
 get_value (View $view=null, Source $source=null, Entry $entry=null, Request $request=null)
 Retrieve the value for this field. More...
 
 is_visible ( $view=null)
 Whether or not this field is visible. More...
 
 update_configuration ( $configuration)
 Update configuration. More...
 

Static Public Member Functions

static by_id ( $field_id)
 Get a from an internal Gravity Forms field ID. More...
 
static from_configuration ( $configuration)
 Create self from a configuration array. More...
 
- Static Public Member Functions inherited from Field
static from_configuration ( $configuration)
 Create self from a configuration array. More...
 
static get ( $source, $args)
 An alias for ::get_field() More...
 

Data Fields

 $field
 
- Data Fields inherited from Field
 $cap = ''
 
 $custom_class = ''
 
 $custom_label = ''
 
 $ID = ''
 
 $label = ''
 
 $position = ''
 
 $search_filter = false
 
 $show_as_link = false
 
 $show_label = true
 
 $UID = ''
 

Additional Inherited Members

- Protected Member Functions inherited from Field
 get_value_filters ( $value, View $view=null, Source $source=null, Entry $entry=null, Request $request=null)
 Apply all the required filters after get_value() was called. More...
 

Detailed Description

If this file is called directly, abort.

The internal field object wrapper.

Used for custom content fields, etc.

Definition at line 14 of file class-gv-field-internal.php.

Member Function Documentation

◆ by_id()

static by_id (   $field_id)
static

Get a from an internal Gravity Forms field ID.

Parameters
int$field_idThe internal Gravity Forms field ID.
Returns
|null The requested field or null if not found.

Retrieve the internal backing field (old for now)

Definition at line 51 of file class-gv-field-internal.php.

References $field, $field_id, and GravityView_Fields\get_instance().

Referenced by gvfield\callback(), View\get_unions(), Views_Route\prepare_entry_for_response(), GravityView_Widget_Search\prepare_field_filter(), GravityView_Field_Sequence\replace_merge_tag(), and View\template_redirect().

◆ from_configuration()

static from_configuration (   $configuration)
static

Create self from a configuration array.

Parameters
array$configurationThe configuration array.
See also
::as_configuration()

Definition at line 30 of file class-gv-field-internal.php.

References $field, and gravityview().

◆ get_label()

get_label ( View  $view = null,
Source  $source = null,
Entry  $entry = null,
Request  $request = null 
)

Retrieve the label for this field.

Parameters
\GV\View$viewThe view for this context if applicable.
\GV\Source$sourceThe source (form) for this context if applicable.
\GV\Entry$entryThe entry for this context if applicable.
\GV\Request$requestThe request for this context if applicable.
Returns
string The label for this field.

Definition at line 75 of file class-gv-field-internal.php.

References $entry, and $label.

◆ get_value()

get_value ( View  $view = null,
Source  $source = null,
Entry  $entry = null,
Request  $request = null 
)

Retrieve the value for this field.

Requires the in this implementation.

Parameters
\GV\View$viewThe view for this context if applicable.
\GV\Source$sourceThe source (form) for this context if applicable.
\GV\Entry$entryThe entry for this context if applicable.
\GV\Request$requestThe request for this context if applicable.
Returns
mixed The value for this field.

For example the "content" field will be empty here. It's value is actually currently retrieved inside ...

drumroll

A TEMPLATE :)

Apply parent filters.

Definition at line 104 of file class-gv-field-internal.php.

References $entry, $value, and gravityview().

Field Documentation

◆ $field

$field

Definition at line 18 of file class-gv-field-internal.php.


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