You are here

public static function MeasurementItem::getPreconfiguredOptions in Physical Fields 8

Returns preconfigured field options for a field type.

Note that if you want to give modules an opportunity to alter the result of this method, you should call \Drupal\Core\Field\FieldTypePluginManagerInterface::getPreconfiguredOptions() instead.

Return value

mixed[][] A multi-dimensional array with string keys and the following structure:

  • label: The label to show in the field type selection list.
  • category: (optional) The category in which to put the field label. Defaults to the category of the field type.
  • field_storage_config: An array with the following supported keys:
    • cardinality: The field cardinality.
    • settings: Field-type specific storage settings.
  • field_config: An array with the following supported keys:
    • required: Indicates whether the field is required.
    • settings: Field-type specific settings.
  • entity_form_display: An array with the following supported keys:
    • type: The widget to be used in the 'default' form mode.
  • entity_view_display: An array with the following supported keys:
    • type: The formatter to be used in the 'default' view mode.

Overrides PreconfiguredFieldUiOptionsInterface::getPreconfiguredOptions

See also

\Drupal\field\Entity\FieldStorageConfig

\Drupal\field\Entity\FieldConfig

\Drupal\Core\Entity\Display\EntityDisplayInterface::setComponent()

\Drupal\Core\Field\FieldTypePluginManagerInterface::getPreconfiguredOptions()

File

src/Plugin/Field/FieldType/MeasurementItem.php, line 135

Class

MeasurementItem
Plugin implementation of the 'physical_measurement' field type.

Namespace

Drupal\physical\Plugin\Field\FieldType

Code

public static function getPreconfiguredOptions() {
  $options = [];

  // Expose an individual field in the Field UI for each measurement type.
  foreach (MeasurementType::getLabels() as $type => $label) {
    $options[$type] = [
      'label' => $label,
      'field_storage_config' => [
        'settings' => [
          'measurement_type' => $type,
        ],
      ],
    ];
  }
  return $options;
}