public static function PathFileEntity::baseFieldDefinitions in Path File 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/PathFileEntity.php, line 154

Class

PathFileEntity

Defines the Path file entity entity.

Namespace

Drupal\path_file\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $config = \Drupal::config('path_file.settings');

  // Allows user's to name this Path File.
  $fields['name'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Name'))
    ->setDescription(t('A name for this Path File.'))
    ->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', TRUE)
    ->setDisplayConfigurable('view', TRUE);

  // URL alias for the file.
  $fields['path'] = BaseFieldDefinition::create('path')
    ->setLabel(t('URL alias'))
    ->setTranslatable(TRUE)
    ->setDisplayOptions('form', array(
    'type' => 'path',
    'weight' => 30,
  ))
    ->setDisplayConfigurable('form', TRUE)
    ->setCustomStorage(TRUE);

  // Allow user to specify the allowed files.
  $extensions_from_config = $config
    ->get('allowed_extensions');

  // File Upload field.
  $fields['fid'] = BaseFieldDefinition::create('file')
    ->setLabel(t('File Name'))
    ->setDescription(t('The File of the associated event.'))
    ->setSetting('file_extensions', $extensions_from_config)
    ->setDisplayOptions('view', array(
    'label' => 'above',
    'type' => 'file',
    'weight' => -3,
  ))
    ->setDisplayOptions('form', array(
    'weight' => -3,
  ))
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);

  // Can be published or unpublished, defaults to true.
  $fields['status'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Publishing status'))
    ->setDescription(t('A boolean indicating whether the Path file 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.'));
  return $fields;
}