public static function SensorResultEntity::baseFieldDefinitions in Monitoring 8

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

File

src/Entity/SensorResultEntity.php, line 38: Contains \Drupal\monitoring\Entity\SensorResultEntity.

Class

SensorResultEntity: The monitoring_sensor_result entity class.

Namespace

Drupal\monitoring\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['record_id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Record ID'))
    ->setDescription(t('The record ID.'))
    ->setReadOnly(TRUE);
  $fields['uuid'] = BaseFieldDefinition::create('uuid')
    ->setLabel(t('UUID'))
    ->setDescription(t('The record UUID.'))
    ->setReadOnly(TRUE);
  $fields['sensor_name'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Sensor name'))
    ->setDescription(t('The machine name of the sensor.'));
  $fields['sensor_status'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Sensor status'))
    ->setDescription(t('The sensor status at the moment of the sensor run.'));
  $fields['sensor_value'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Sensor value'))
    ->setDescription(t('The sensor value at the moment of the sensor run.'));
  $fields['sensor_message'] = BaseFieldDefinition::create('string_long')
    ->setLabel(t('Sensor message'))
    ->setDescription(t('The sensor message reported by the sensor.'));
  $fields['timestamp'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Timestamp'))
    ->setDescription(t('The time that the sensor was executed.'));
  $fields['execution_time'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Execution time'))
    ->setDescription(t('The time needed for the sensor to execute in ms.'));
  return $fields;
}

You are here