public static function SplashifyEntity::baseFieldDefinitions in Splashify 8.2

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/SplashifyEntity.php, line 169

Class

SplashifyEntity

Defines the Splashify entity entity.

Namespace

Drupal\splashify\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['user_id'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Authored by'))
    ->setDescription(t('The user ID of author of the Splashify entity entity.'))
    ->setRevisionable(TRUE)
    ->setSetting('target_type', 'user')
    ->setSetting('handler', 'default')
    ->setDefaultValueCallback('Drupal\\node\\Entity\\Node::getCurrentUserId')
    ->setTranslatable(TRUE)
    ->setDisplayOptions('view', array(
    'label' => 'hidden',
    'type' => 'author',
    'weight' => -5,
  ))
    ->setDisplayConfigurable('form', FALSE)
    ->setDisplayConfigurable('view', FALSE);
  $fields['name'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Name'))
    ->setDescription(t('The name of the Splashify entity entity.'))
    ->setRequired(TRUE)
    ->setSettings(array(
    'max_length' => 50,
    'text_processing' => 0,
  ))
    ->setDefaultValue('')
    ->setDisplayOptions('view', array(
    'label' => 'above',
    'type' => 'string',
    'weight' => -4,
  ))
    ->setDisplayOptions('form', array(
    'type' => 'string_textfield',
    'weight' => -4,
  ))
    ->setDisplayConfigurable('form', FALSE)
    ->setDisplayConfigurable('view', FALSE);
  $fields['status'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Publishing status'))
    ->setDescription(t('A boolean indicating whether the Splashify entity is published.'))
    ->setDefaultValue(TRUE);
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Created'))
    ->setDescription(t('The time that the entity was created.'));
  $fields['changed'] = BaseFieldDefinition::create('changed')
    ->setLabel(t('Changed'))
    ->setDescription(t('The time that the entity was last edited.'));
  $fields['field_content'] = BaseFieldDefinition::create('text_long')
    ->setLabel(t('Content'))
    ->setRequired(TRUE)
    ->setTranslatable(FALSE)
    ->setDisplayOptions('view', array(
    'type' => 'text_default',
    'label' => 'hidden',
    'weight' => -3,
  ))
    ->setDisplayOptions('form', array(
    'type' => 'text_textarea',
    'weight' => -3,
    'settings' => array(
      'rows' => 5,
    ),
  ))
    ->setDisplayConfigurable('from', FALSE)
    ->setDisplayConfigurable('view', FALSE);
  $fields['field_group'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Group'))
    ->setRequired(TRUE)
    ->setTranslatable(FALSE)
    ->setSetting('target_type', 'splashify_group_entity')
    ->setSetting('handler', 'default')
    ->setDisplayOptions('view', array(
    'type' => 'entity_reference_label',
    'label' => 'inline',
    'weight' => -2,
    'settings' => array(
      'link' => TRUE,
    ),
  ))
    ->setDisplayOptions('form', array(
    'type' => 'entity_reference_autocomplete',
    'weight' => -2,
    'settings' => array(
      'match_operator' => 'CONTAINS',
      'size' => 60,
    ),
  ))
    ->setDisplayConfigurable('from', FALSE)
    ->setDisplayConfigurable('view', FALSE);
  $fields['field_weight'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Weight'))
    ->setRequired(FALSE)
    ->setTranslatable(FALSE)
    ->setSetting('min', -20)
    ->setSetting('max', 20)
    ->setDefaultValue(0)
    ->setDisplayOptions('view', array(
    'type' => 'number_integer',
    'label' => 'hidden',
    'weight' => -1,
  ))
    ->setDisplayOptions('form', array(
    'type' => 'number',
    'weight' => -1,
  ))
    ->setDisplayConfigurable('from', FALSE)
    ->setDisplayConfigurable('view', FALSE);
  return $fields;
}