public static function OpignoNotification::baseFieldDefinitions in Opigno notifications 8

Same name and namespace in other branches

1. 3.x src/Entity/OpignoNotification.php \Drupal\opigno_notification\Entity\OpignoNotification::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/OpignoNotification.php, line 37

Class

OpignoNotification

Defines the opigno_notification entity.

Namespace

Drupal\opigno_notification\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('ID'))
    ->setDescription(t('The ID of the OpignoNotification entity.'))
    ->setReadOnly(TRUE);
  $fields['uuid'] = BaseFieldDefinition::create('uuid')
    ->setLabel(t('UUID'))
    ->setDescription(t('The UUID of the OpignoNotification entity.'))
    ->setReadOnly(TRUE);
  $fields['created'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Creation time'))
    ->setDescription(t('The creation time of the notification.'))
    ->setReadOnly(TRUE);
  $fields['uid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('User'))
    ->setDescription(t('The user ID of the notification receiver.'))
    ->setRequired(TRUE)
    ->setSettings([
    'default_value' => 0,
    'target_type' => 'user',
  ])
    ->setDisplayOptions('view', [
    'label' => 'above',
    'type' => 'entity_reference_label',
    'weight' => 0,
  ]);
  $fields['message'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Message'))
    ->setDescription(t('The message of the notification.'))
    ->setRequired(TRUE)
    ->setTranslatable(TRUE)
    ->setSettings([
    'default_value' => '',
    'max_length' => 255,
  ])
    ->setDisplayOptions('view', [
    'label' => 'above',
    'type' => 'string',
    'weight' => 1,
  ]);
  $fields['has_read'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Has Read'))
    ->setDescription(t('The status of the notification.'))
    ->setRequired(TRUE)
    ->setSettings([
    'default_value' => 0,
  ]);
  $fields['url'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Url'))
    ->setDescription(t('The url string for notification entity.'))
    ->setSettings([
    'max_length' => 50,
  ])
    ->setInitialValue('/notifications')
    ->setDefaultValue('/notifications');
  return $fields;
}