You are here

public static function BrokenLinkRedirect::baseFieldDefinitions in Broken Link 8

Same name and namespace in other branches
  1. 8.3 src/Entity/BrokenLinkRedirect.php \Drupal\broken_link\Entity\BrokenLinkRedirect::baseFieldDefinitions()
  2. 8.2 src/Entity/BrokenLinkRedirect.php \Drupal\broken_link\Entity\BrokenLinkRedirect::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/BrokenLinkRedirect.php, line 48

Class

BrokenLinkRedirect
Defines the Broken link redirect entity entity.

Namespace

Drupal\broken_link\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Entity ID'))
    ->setDescription(t('The entity ID for this broken link redirect content entity.'))
    ->setReadOnly(TRUE)
    ->setSetting('unsigned', TRUE);
  $fields['uuid'] = BaseFieldDefinition::create('uuid')
    ->setLabel(t('UUID'))
    ->setDescription(t('The content broken link redirect UUID.'))
    ->setReadOnly(TRUE);
  $fields['pattern'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Pattern'))
    ->setSettings(array(
    'default_value' => '.*',
  ))
    ->setDescription(t('Broken link pattern.'));
  $fields['redirect_path'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Redirect path'))
    ->setSettings(array(
    'default_value' => '.*',
  ))
    ->setDescription(t('Redirect path for broken link.'));
  $fields['enabled'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Enabled'))
    ->setDescription(t('Broken link pattern enabled/disabled.'))
    ->setSettings(array(
    'default_value' => TRUE,
  ));
  $fields['weight'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Entity weight'))
    ->setDescription(t('Broken link pattern weightage.'))
    ->setSetting('unsigned', FALSE);
  return $fields;
}