You are here

public static function WebformProtectedDownloads::baseFieldDefinitions in Webform Protected Downloads 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

See also

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

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

File

src/Entity/WebformProtectedDownloads.php, line 72

Class

WebformProtectedDownloads
Defines the Webform protected downloads entity.

Namespace

Drupal\webform_protected_downloads\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['webform_submission'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Webform Submission'))
    ->setSetting('target_type', 'webform_submission')
    ->setRequired(TRUE);
  $fields['file'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('File'))
    ->setSetting('target_type', 'file')
    ->setRequired(TRUE)
    ->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED);
  $fields['hash'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Hash'))
    ->setRequired(TRUE);
  $fields['active'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Active'))
    ->setDefaultValue(FALSE);
  $fields['expire'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Expire'))
    ->setRequired(TRUE);
  $fields['onetime'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Onetime'))
    ->setDefaultValue(FALSE)
    ->setRequired(TRUE);
  return $fields;
}