Drupal\tripal_chado\Plugin\Field\FieldType\ChadoAdditionalTypeTypeDefault Class Reference

Inheritance diagram for Drupal\tripal_chado\Plugin\Field\FieldType\ChadoAdditionalTypeTypeDefault:

Collaboration diagram for Drupal\tripal_chado\Plugin\Field\FieldType\ChadoAdditionalTypeTypeDefault:

Public Member Functions
	storageSettingsForm (array &$form, FormStateInterface $form_state, $has_data)
	storageSettingsFormTypeFKeyAjaxCallback ($form, &$form_state)
Public Member Functions inherited from Drupal\tripal_chado\TripalField\ChadoFieldItemBase
	storageSettingsFormBaseTableAjaxCallback ($form, &$form_state)
	storageSettingsFormLinkingMethodAjaxCallback ($form, &$form_state)
Public Member Functions inherited from Drupal\tripal\TripalField\TripalFieldItemBase
	fieldSettingsForm (array $form, FormStateInterface $form_state)
	tripalStorageId ()
	tripalSave ($field_item, $field_name, $prop_types, $prop_values, $entity)
	tripalLoad ($field_item, $field_name, $prop_types, $prop_values, $entity)
	tripalClear ($field_item, $field_name, $prop_types, $prop_values, $entity)
	sanitizeKey ($key)
	tripalValuesTemplate ($field_definition, $default_value=NULL)

Static Public Member Functions
static	mainPropertyName ()
static	defaultFieldSettings ()
static	defaultStorageSettings ()
static	tripalTypes ($field_definition)
static	storageSettingsFormValidate (array $form, FormStateInterface $form_state)
Static Public Member Functions inherited from Drupal\tripal_chado\TripalField\ChadoFieldItemBase
static	storageSettingsFormValidateBaseTable (array $form, FormStateInterface $form_state)
static	storageSettingsFormValidateLinkingMethod (array $form, FormStateInterface $form_state)
Static Public Member Functions inherited from Drupal\tripal\TripalField\TripalFieldItemBase
static	fieldSettingsFormValidate (array $form, FormStateInterface $form_state)
static	propertyDefinitions (FieldStorageDefinitionInterface $field_definition)
static	schema (FieldStorageDefinitionInterface $field_definition)

Static Public Attributes
static	$id = 'chado_additional_type_type_default'
static	$table_column_delimiter = " \u{2192} "

Protected Member Functions
	getTypeFKeys ($base_table)
Protected Member Functions inherited from Drupal\tripal_chado\TripalField\ChadoFieldItemBase
	getBaseTables ($linked_table, $has_linker_table=FALSE)
	getTableColumns ($table_name='', $column_types=[])
	getLinkerTables ($linked_table, $base_table, $delimiter=" \u{2192} ")
Protected Member Functions inherited from Drupal\tripal\TripalField\TripalFieldItemBase
	buildVocabularyTermTable (array &$elements, \Drupal\tripal\TripalVocabTerms\TripalTerm $term, \Drupal\tripal\TripalVocabTerms\TripalIdSpaceBase $idSpace, \Drupal\tripal\TripalVocabTerms\TripalVocabularyBase $vocabulary)

Additional Inherited Members
Static Protected Attributes inherited from Drupal\tripal_chado\TripalField\ChadoFieldItemBase
static	$table_column_delimiter = " \u{2192} "

Detailed Description

Plugin implementation of Tripal additional type field type.

@FieldType( id = "chado_additional_type_type_default", label = @Translation("Chado Type Reference"), description = @Translation("A Chado type reference"), default_widget = "chado_additional_type_widget_default", default_formatter = "chado_additional_type_formatter_default" )

Member Function Documentation

defaultFieldSettings()

static Drupal\tripal_chado\Plugin\Field\FieldType\ChadoAdditionalTypeTypeDefault::defaultFieldSettings ( )

static

{{}}

Reimplemented from Drupal\tripal\TripalField\TripalFieldItemBase.

defaultStorageSettings()

static Drupal\tripal_chado\Plugin\Field\FieldType\ChadoAdditionalTypeTypeDefault::defaultStorageSettings ( )

static

{{{}}}

Reimplemented from Drupal\tripal_chado\TripalField\ChadoFieldItemBase.

getTypeFKeys()

Drupal\tripal_chado\Plugin\Field\FieldType\ChadoAdditionalTypeTypeDefault::getTypeFKeys (   $base_table )

protected

Return a list of candidate type tables. This is done by returning tables that have a foreign key to our $base_table, and have a column with a foreign key to cvterm. These tables+columns are returned in an alphabetized list ready to use in a form select, with the base table, if present, included at the top.

Parameters

string

$base_table

The Chado base table being used for this field.

mainPropertyName()

static Drupal\tripal_chado\Plugin\Field\FieldType\ChadoAdditionalTypeTypeDefault::mainPropertyName ( )

static

{}

storageSettingsForm()

Drupal\tripal_chado\Plugin\Field\FieldType\ChadoAdditionalTypeTypeDefault::storageSettingsForm	(	array &	$form,
		FormStateInterface	$form_state,
			$has_data
	)

{{{}}}

Reimplemented from Drupal\tripal_chado\TripalField\ChadoFieldItemBase.

storageSettingsFormTypeFKeyAjaxCallback()

Drupal\tripal_chado\Plugin\Field\FieldType\ChadoAdditionalTypeTypeDefault::storageSettingsFormTypeFKeyAjaxCallback	(		$form,
		&	$form_state
	)

Ajax callback to update the type table+column select. This is needed because the select can't be populated until we know the base table.

Parameters

array	$form	The form array.
\Drupal\Core\Form\FormStateInterface	$form_state	The form state object.

storageSettingsFormValidate()

static Drupal\tripal_chado\Plugin\Field\FieldType\ChadoAdditionalTypeTypeDefault::storageSettingsFormValidate ( array  $form, FormStateInterface  $form_state  )

static

Form element validation handler for type table and column

Parameters

array	$form	The form where the settings form is being included in.
\Drupal\Core\Form\FormStateInterface	$form_state	The form state of the (entire) configuration form.

tripalTypes()

static Drupal\tripal_chado\Plugin\Field\FieldType\ChadoAdditionalTypeTypeDefault::tripalTypes (   $field_definition )

static

{Returns the property types required by this field.

Parameters

object

$field_definition

The field configuration object. This can be an instance of: \Drupal\field\Entity\FieldStorageConfig or \Drupal\field\Entity\FieldConfig

Returns

array Array of \Drupal\tripal\TripalStorage\StoragePropertyTypeBase property types.

}

Implements Drupal\tripal\TripalField\Interfaces\TripalFieldItemInterface.

---

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

• tripal_chado/src/Plugin/Field/FieldType/ChadoAdditionalTypeTypeDefault.php