Tripal
Public Member Functions | Static Public Attributes | List of all members
remote__data_formatter Class Reference
Inheritance diagram for remote__data_formatter:
Inheritance graph
[legend]
Collaboration diagram for remote__data_formatter:
Collaboration graph
[legend]

Public Member Functions

 view (&$element, $entity_type, $entity, $langcode, $items, $display)
 
 settingsSummary ($view_mode)
 
- Public Member Functions inherited from TripalFieldFormatter
 __construct ($field, $instance=NULL)
 
 settingsForm ($view_mode, $form, &$form_state)
 

Static Public Attributes

static $default_label = 'Remote Data'
 
static $field_types = ['remote__data']
 
static $default_settings
 
- Static Public Attributes inherited from TripalFieldFormatter
static $default_label = 'Tripal Field.'
 
static $field_types = []
 
static $default_settings = []
 

Additional Inherited Members

- Static Public Member Functions inherited from TripalFieldFormatter
static info ()
 
- Protected Member Functions inherited from TripalFieldFormatter
 ajaxifyPager ($pager, $entity)
 

Member Function Documentation

◆ settingsSummary()

remote__data_formatter::settingsSummary (   $view_mode)

Provides a summary of the formatter settings.

This function corresponds to the hook_field_formatter_settings_summary() function of the Drupal Field API.

On the 'Manage Display' page of the content type administration page, fields are allowed to provide a settings form. This settings form can be used to allow the site admin to define how the field should be formatted. The settings are then available for the formatter() function of this class. This function provides a text-based description of the settings for the site developer to see. It appears on the manage display page inline with the field. A field must always return a value in this function if the settings form gear button is to appear.

See the hook_field_formatter_settings_summary() function for more information.

Parameters
$field
$instance
$view_mode
Returns
string A string that provides a very brief summary of the field settings to the user.

Reimplemented from TripalFieldFormatter.

◆ view()

remote__data_formatter::view ( $element,
  $entity_type,
  $entity,
  $langcode,
  $items,
  $display 
)

Member Data Documentation

◆ $default_settings

remote__data_formatter::$default_settings
static
Initial value:
= [
'setting1' => 'default_value',
]

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