1. trait
  2. Drupal
  3. \
  4. user
  5. \
  6. EntityOwnerTrait

EntityOwnerTrait

trait EntityOwnerTrait (View source)

Provides a trait for entities that have an owner.

Methods

static BaseFieldDefinition[]
ownerBaseFieldDefinitions(EntityTypeInterface $entity_type)

Returns an array of base field definitions for entity owners.

getOwnerId()

{@inheritdoc}

setOwnerId($uid)

{@inheritdoc}

getOwner()

{@inheritdoc}

setOwner(UserInterface $account)

{@inheritdoc}

static mixed
getDefaultEntityOwner()

Default value callback for 'owner' base field.

Details

at line 28
static BaseFieldDefinition[] ownerBaseFieldDefinitions(EntityTypeInterface $entity_type)

Returns an array of base field definitions for entity owners.

Parameters

EntityTypeInterface $entity_type

The entity type to add the owner field to.

Return Value

BaseFieldDefinition[]

An array of base field definitions.

Exceptions

UnsupportedEntityTypeDefinitionException

at line 48
getOwnerId()

{@inheritdoc}

at line 55
setOwnerId($uid)

{@inheritdoc}

Parameters

$uid

at line 65
getOwner()

{@inheritdoc}

at line 73
setOwner(UserInterface $account)

{@inheritdoc}

Parameters

UserInterface $account

at line 86
static mixed getDefaultEntityOwner()

Default value callback for 'owner' base field.

Return Value

mixed

A default value for the owner field.