public static function TweetEntity::baseFieldDefinitions in Tweet Feed 4.x

Same name and namespace in other branches

1. 8.3 src/Entity/TweetEntity.php \Drupal\tweet_feed\Entity\TweetEntity::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/TweetEntity.php, line 474

Class

TweetEntity

Defines the Tweet Feed Tweet entity.

Namespace

Drupal\tweet_feed\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);

  // Standard field, used as unique if primary index.
  $fields['id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('ID'))
    ->setDescription(t('The ID of the tweet entity.'))
    ->setReadOnly(TRUE);
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Created'))
    ->setDescription(t('The time that the entity was created.'));

  // Standard field, unique outside of the scope of the current project.
  $fields['changed'] = BaseFieldDefinition::create('changed')
    ->setLabel(t('Changed'))
    ->setDescription(t('The time that the entity was last changed.'));

  // Standard field, unique outside of the scope of the current project.
  $fields['user_id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('User Id'))
    ->setDescription(t('The user id of the owner of this tweet.'))
    ->setReadOnly(FALSE);

  // Standard field, unique outside of the scope of the current project.
  $fields['uuid'] = BaseFieldDefinition::create('uuid')
    ->setLabel(t('UUID'))
    ->setDescription(t('The UUID of the tweet entity.'))
    ->setReadOnly(TRUE);
  $fields['feed_machine_name'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Feed machine name'))
    ->setDescription(t('The machine name of the feed that owns this tweet.'))
    ->setRevisionable(FALSE)
    ->setTranslatable(FALSE)
    ->setDisplayOptions('view', [
    'label' => 'above',
    'weight' => 0,
  ])
    ->setDisplayOptions('form', [
    'weight' => 0,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['tweet_id'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Tweet ID'))
    ->setDescription(t('The Twitter ID for this tweet.'))
    ->setRevisionable(FALSE)
    ->setTranslatable(FALSE)
    ->setDisplayOptions('view', [
    'label' => 'above',
    'weight' => 5,
  ])
    ->setDisplayOptions('form', [
    'weight' => 5,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['tweet_title'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Tweet Title'))
    ->setDescription(t('The cleansed title for this tweet. For administrative use only.'))
    ->setRevisionable(FALSE)
    ->setTranslatable(FALSE)
    ->setDisplayOptions('view', [
    'label' => 'above',
    'weight' => 10,
  ])
    ->setDisplayOptions('form', [
    'weight' => 10,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['tweet_full_text'] = BaseFieldDefinition::create('text_long')
    ->setLabel(t('Tweet Full Text'))
    ->setDescription(t('The contents of the tweet. Untruncated.'))
    ->setDisplayOptions('view', [
    'label' => 'above',
    'weight' => 15,
  ])
    ->setDisplayOptions('form', [
    'weight' => 15,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['tweet_user_profile_id'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Tweet Author ID'))
    ->setDescription(t('The Twitter ID of the author of this tweet.'))
    ->setRevisionable(FALSE)
    ->setTranslatable(FALSE)
    ->setDisplayOptions('view', [
    'label' => 'above',
    'weight' => 20,
  ])
    ->setDisplayOptions('form', [
    'weight' => 20,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['is_verified_user'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Is this a verified user?'))
    ->setDefaultValue(FALSE)
    ->setDisplayOptions('view', [
    'label' => 'above',
    'type' => 'boolean',
    'weight' => 25,
  ])
    ->setDisplayOptions('form', [
    'weight' => 25,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['linked_images'] = BaseFieldDefinition::create('image')
    ->setLabel(t('Linked Images'))
    ->setDescription(t('Images linked in tweets.'))
    ->setSettings([
    'uri_scheme' => 'public',
    'file_directory' => 'tweet-feed-tweet-images/[date:custom:Y]-[date:custom:m]',
    'alt_field_required' => FALSE,
    'file_extensions' => 'png jpg jpeg gif',
  ])
    ->setDisplayOptions('view', array(
    'label' => 'hidden',
    'type' => 'default',
    'weight' => 30,
  ))
    ->setDisplayOptions('form', array(
    'weight' => 30,
  ))
    ->setCardinality(-1)
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['hashtags'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Hashtags Used'))
    ->setDescription(t('Any hashtags that are contained in a tweet.'))
    ->setRevisionable(FALSE)
    ->setSetting('target_type', 'taxonomy_term')
    ->setSetting('handler', 'default:taxonomy_term')
    ->setSetting('handler_settings', [
    'target_bundles' => [
      'twitter_hashtag_terms' => 'twitter_hashtag_terms',
    ],
  ])
    ->setTranslatable(FALSE)
    ->setDisplayOptions('view', [
    'weight' => 35,
  ])
    ->setDisplayOptions('form', [
    'type' => 'entity_reference_autocomplete',
    'weight' => 35,
    'settings' => [
      'match_operator' => 'CONTAINS',
      'size' => '60',
      'autocomplete_type' => 'tags',
      'placeholder' => '',
    ],
  ])
    ->setCardinality(-1)
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['user_mentions'] = BaseFieldDefinition::create('user_mentions_field_type')
    ->setLabel(t('User Mentions'))
    ->setDescription(t('Users mentioned in the tweet'))
    ->setSettings([
    'max_length' => 50,
    'text_processing' => 0,
  ])
    ->setDefaultValue('')
    ->setDisplayOptions('view', [
    'label' => 'above',
    'type' => 'string',
    'weight' => 40,
  ])
    ->setDisplayOptions('form', [
    'type' => 'user_mentions_field_type',
    'weight' => 40,
  ])
    ->setCardinality(-1)
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['geographic_coordinates'] = BaseFieldDefinition::create('string_long')
    ->setLabel(t('Geographic Coordinates'))
    ->setDescription(t('The geographic coordinates of a tweet if provided.'))
    ->setRevisionable(FALSE)
    ->setTranslatable(FALSE)
    ->setDisplayOptions('view', [
    'label' => 'above',
    'weight' => 45,
  ])
    ->setDisplayOptions('form', [
    'weight' => 45,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['geographic_place'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Geographic Place'))
    ->setDescription(t('The geographic location of a tweet if provided.'))
    ->setRevisionable(FALSE)
    ->setTranslatable(FALSE)
    ->setDisplayOptions('view', [
    'label' => 'above',
    'weight' => 50,
  ])
    ->setDisplayOptions('form', [
    'weight' => 50,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['source'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Tweet Source'))
    ->setDescription(t('The name of the application used to generate a tweet.'))
    ->setRevisionable(FALSE)
    ->setTranslatable(FALSE)
    ->setDisplayOptions('view', [
    'label' => 'above',
    'weight' => 55,
  ])
    ->setDisplayOptions('form', [
    'weight' => 55,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['user_mentions_tags'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('User Mentions'))
    ->setDescription(t('The users mentioned in a tweet in the form of tags.'))
    ->setSetting('target_type', 'taxonomy_term')
    ->setSetting('handler', 'default:taxonomy_term')
    ->setSetting('handler_settings', [
    'target_bundles' => [
      'twitter_user_mention_terms' => 'twitter_user_mention_terms',
    ],
  ])
    ->setTranslatable(FALSE)
    ->setDisplayOptions('view', [
    'weight' => 60,
  ])
    ->setDisplayOptions('form', [
    'type' => 'entity_reference_autocomplete',
    'weight' => 60,
    'settings' => [
      'match_operator' => 'CONTAINS',
      'size' => '60',
      'autocomplete_type' => 'tags',
      'placeholder' => '',
    ],
  ])
    ->setCardinality(-1)
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['type_of_tweet_reference'] = BaseFieldDefinition::create('list_string')
    ->setLabel(t('Type of Tweet Reference'))
    ->setDescription(t('Is this a re-tweet with a comment, a tweet that was replied to, or a quoted tweet? Helps provide minimal context.'))
    ->setDefaultValue(FALSE)
    ->setDisplayOptions('view', [
    'label' => 'above',
    'weight' => 65,
  ])
    ->setDisplayOptions('form', [
    'weight' => 65,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE)
    ->setSettings([
    'allowed_values' => [
      'replied' => t('Reply'),
      'retweeted' => t('Re-Tweet'),
      'quoted' => t('Quoted Re-Tweet'),
    ],
  ])
    ->setDefaultValue([
    [
      'value' => 'standard',
    ],
  ]);
  $fields['referenced_tweet_id'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Referenced Tweet ID'))
    ->setRevisionable(FALSE)
    ->setTranslatable(FALSE)
    ->setDisplayOptions('view', [
    'label' => 'above',
    'weight' => 70,
  ])
    ->setDisplayOptions('form', [
    'weight' => 70,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['link_to_tweet'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Tweet Link'))
    ->setDescription(t('The URL that will take the user to the tweet on Twitter.'))
    ->setRevisionable(FALSE)
    ->setTranslatable(FALSE)
    ->setDisplayOptions('view', [
    'label' => 'above',
    'weight' => 75,
  ])
    ->setDisplayOptions('form', [
    'weight' => 75,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['profile_image'] = BaseFieldDefinition::create('image')
    ->setLabel(t('Profile Image'))
    ->setDescription(t('The Profile Image of the Tweeter.'))
    ->setSettings([
    'uri_scheme' => 'public',
    'file_directory' => 'tweet-feed-tweet-profile-images/[date:custom:Y]-[date:custom:m]',
    'alt_field_required' => FALSE,
    'file_extensions' => 'png jpg jpeg gif',
  ])
    ->setDisplayOptions('view', array(
    'label' => 'hidden',
    'type' => 'default',
    'weight' => 85,
  ))
    ->setDisplayOptions('form', array(
    'weight' => 85,
  ))
    ->setCardinality(1)
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  return $fields;
}