TripalFieldFormatter Class Reference

Inheritance diagram for TripalFieldFormatter:

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

Static Public Member Functions
static	info ()

Static Public Attributes
static	$default_label = 'Tripal Field.'
static	$field_types = []
static	$default_settings = []

Protected Member Functions
	ajaxifyPager ($pager, $entity)

Constructor & Destructor Documentation

__construct()

TripalFieldFormatter::__construct	(		$field,
			$instance = NULL
	)

Instantiates a new TripalFieldFormatter object.

Parameters

$field	An array containing the field data as returned by field_info_field()
$instance	(Optional). Set the instance of this field when one is available. This is necessary when working with instance specific functions such as the formatterSettingsForm, widgetForm, etc.

Member Function Documentation

ajaxifyPager()

TripalFieldFormatter::ajaxifyPager (   $pager,   $entity  )

protected

Updates a pager generated by theme('pager') for use with AJAX.

Because fields are meant to be updated by AJAX we need clicks in the pager to not reload the entire page but rather to only reload the field. Therefore the links in the pager must be adjusted to support this.

Parameters

$pager	The pager as created by theme('pager')
$entity	The entity object.

info()

static TripalFieldFormatter::info ( )

static

Provides information about the formatter for this field.

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

This is a static function as it provides default values for all of the formatters for this field type, and thus we don't need an instantiated object to provide this information.

Returns

An associative array with key/value paris compatible with those from the hook_field_formatter_info() function of the Drupal Field API.

settingsForm()

TripalFieldFormatter::settingsForm	(		$view_mode,
			$form,
		&	$form_state
	)

Provides the field's setting form.

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

The settings form appears on the 'Manage Display' page of the content type administration page. This function provides the form that will appear on that page.

To add a validate function, please create a static function in the implementing class, and indicate that this function should be used in the form array that is returned by this function.

This form will not be displayed if the formatter_settings_summary() function does not return anything.

param $field The field structure being configured. param $instance The instance structure being configured. param $view_mode The view mode being configured. param $form The (entire) configuration form array, which will usually have no use here. Typically for reference only. param $form_state The form state of the (entire) configuration form.

Returns

A Drupal Form array containing the settings form for this field.

Reimplemented in sep__protocol_formatter, sbo__relationship_table_formatter, sbo__relationship_formatter, local__contact_formatter, data__sequence_coordinates_table_formatter, chado_linker__prop_formatter, and chado_linker__contact_formatter.

settingsSummary()

TripalFieldFormatter::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 in remote__data_formatter, sep__protocol_formatter, sbo__relationship_table_formatter, sbo__relationship_formatter, and data__sequence_coordinates_table_formatter.

view()

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

Provides the display for a field

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

This function provides the display for a field when it is viewed on as a full page, teaser, indexing for searching, etc. The content returned by the formatter should only include what is present in the $items[$delta]['values] array. This way, the contents that are displayed on the page, via web services and downloaded into a CSV file will always be identical. The view need not show all of the data in the 'values' array.

Parameters

$element	A renderable array for the $items, as an array of child elements keyed by numeric indexes starting from 0. When implemented as a child class, this argument is set for the display.
$entity_type	The type of $entity.
$entity	The entity object.
$langcode	The language associated with $items.
$items	Array of values for this field.
$display	The display settings to use, as found in the 'display' entry of instance definitions. The array notably contains the following keys and values; type: The name of the formatter to use. settings: The array of formatter settings.

Reimplemented in remote__data_formatter, uo__unit_formatter, taxrank__infraspecific_taxon_formatter, so__transcript_formatter, so__genotype_formatter, so__cds_formatter, sio__vocabulary_formatter, sio__references_formatter, sio__annotation_formatter, sep__protocol_formatter, schema__publication_formatter, schema__alternate_name_formatter, schema__additional_type_formatter, sbo__relationship_table_formatter, sbo__relationship_formatter, sbo__phenotype_formatter, sbo__database_cross_reference_formatter, operation__phylotree_vis_formatter, operation__analysis_formatter, ogi__location_on_map_formatter, obi__organism_formatter, local__source_data_formatter, local__contact_formatter, go__gene_expression_formatter, efo__array_design_formatter, data__sequence_record_formatter, data__sequence_length_formatter, data__sequence_coordinates_table_formatter, data__sequence_coordinates_formatter, data__sequence_checksum_formatter, data__sequence_formatter, data__protein_sequence_formatter, data__accession_formatter, chado_linker__prop_formatter, chado_linker__contact_formatter, and rdfs__type_formatter.

Member Data Documentation

$default_label

TripalFieldFormatter::$default_label = 'Tripal Field.'

static

The default label for this field.

$default_settings

TripalFieldFormatter::$default_settings = []

static

The list of default settings for this formatter.

$field_types

TripalFieldFormatter::$field_types = []

static

The list of field types for which this formatter is appropriate.

---

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

• tripal/includes/TripalFields/TripalFieldFormatter.inc