public static function WeatherDisplayPlace::baseFieldDefinitions in Weather 2.0.x

Same name and namespace in other branches

1. 8 src/Entity/WeatherDisplayPlace.php \Drupal\weather\Entity\WeatherDisplayPlace::baseFieldDefinitions()

Provides base field definitions for an entity type.

Implementations typically use the class \Drupal\Core\Field\BaseFieldDefinition for creating the field definitions; for example a 'name' field could be defined as the following:

$fields['name'] = BaseFieldDefinition::create('string')
  ->setLabel(t('Name'));

By definition, base fields are fields that exist for every bundle. To provide definitions for fields that should only exist on some bundles, use \Drupal\Core\Entity\FieldableEntityInterface::bundleFieldDefinitions().

The definitions returned by this function can be overridden for all bundles by hook_entity_base_field_info_alter() or overridden on a per-bundle basis via 'base_field_override' configuration entities.

Parameters

\Drupal\Core\Entity\EntityTypeInterface $entity_type: The entity type definition. Useful when a single class is used for multiple, possibly dynamic entity types.

Return value

\Drupal\Core\Field\FieldDefinitionInterface[] An array of base field definitions for the entity type, keyed by field name.

Overrides ContentEntityBase::baseFieldDefinitions

See also

\Drupal\Core\Entity\EntityFieldManagerInterface::getFieldDefinitions()

\Drupal\Core\Entity\FieldableEntityInterface::bundleFieldDefinitions()

File

src/Entity/WeatherDisplayPlace.php, line 42

Class

WeatherDisplayPlace

Defines the Weather display place entity.

Namespace

Drupal\weather\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = [];
  $fields['id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('ID'))
    ->setDescription(t('ID.'))
    ->setReadOnly(TRUE)
    ->setSetting('unsigned', TRUE);
  $fields['display_type'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Type of display'))
    ->setDescription('Type of display (system-wide, user, location, default, ...).')
    ->setRequired(TRUE)
    ->setSetting('max_length', 20);
  $fields['display_number'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Display number'))
    ->setDescription(t('Display number'))
    ->setRequired(TRUE)
    ->setDefaultValue(0);
  $fields['geoid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Geoid'))
    ->setRequired(TRUE)
    ->setDescription('GeoID of the location')
    ->setSetting('target_type', 'weather_place');
  $fields['displayed_name'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Displayed name of place'))
    ->setDescription('Displayed name of place')
    ->setSetting('max_length', 255);
  $fields['weight'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Weight of the location'))
    ->setDescription(t('Weight of the location'))
    ->setRequired(TRUE)
    ->setDefaultValue(0);
  return $fields;
}