public static function WeatherForecastInformation::baseFieldDefinitions in Weather 8

Same name and namespace in other branches

1. 2.0.x src/Entity/WeatherForecastInformation.php \Drupal\weather\Entity\WeatherForecastInformation::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/WeatherForecastInformation.php, line 29

Class

WeatherForecastInformation

Defines the Weather forecast information entity.

Namespace

Drupal\weather\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = [];
  $fields['geoid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Geoid'))
    ->setRequired(TRUE)
    ->setDescription('GeoID of the location')
    ->setSetting('target_type', 'weather_place');
  $fields['last_update'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Last update'))
    ->setDescription('UTC time of last update')
    ->setRequired(TRUE)
    ->setSetting('max_length', 20);
  $fields['next_update'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Next scheduled update'))
    ->setDescription('UTC time of next scheduled update')
    ->setRequired(TRUE)
    ->setSetting('max_length', 20);
  $fields['next_download_attempt'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Scheduled download attempt'))
    ->setDescription('UTC time of next scheduled download attempt')
    ->setRequired(TRUE)
    ->setSetting('max_length', 20);
  $fields['utc_offset'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('UTC offset of local time'))
    ->setDescription(t('UTC offset of local time in minutes'))
    ->setDefaultValue(NULL);
  return $fields;
}