public static function OrderReport::baseFieldDefinitions in Commerce Reporting 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/OrderReport.php, line 83

Class

OrderReport

Defines the order report entity class.

Namespace

Drupal\commerce_reports\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['order_id'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Order'))
    ->setDescription(t('The parent order.'))
    ->setSetting('target_type', 'commerce_order')
    ->setReadOnly(TRUE);
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Created'))
    ->setDescription(t('The time when the order report was created.'))
    ->setReadOnly(TRUE);
  $fields['updated'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Updated'))
    ->setDescription(t('The time when the order report was updated.'))
    ->setReadOnly(TRUE);
  return $fields;
}