interface EntityOwnerInterface

Same name in other branches
  1. 8.9.x core/modules/user/src/EntityOwnerInterface.php \Drupal\user\EntityOwnerInterface
  2. 10 core/modules/user/src/EntityOwnerInterface.php \Drupal\user\EntityOwnerInterface
  3. 11.x core/modules/user/src/EntityOwnerInterface.php \Drupal\user\EntityOwnerInterface

Defines a common interface for entities that have an owner.

An owner is someone who has primary control over an entity, similar to owners in Unix file system access. This may or may not be the entity's original author. The owner may also have less permissions than other users, such as administrators.

Hierarchy

Expanded class hierarchy of EntityOwnerInterface

All classes that implement EntityOwnerInterface

Related topics

Entity type characteristics
Describes how to enhance entity types with additional functionality.
16 files declare their use of EntityOwnerInterface
CommentInterface.php in core/modules/comment/src/CommentInterface.php
CommentStatistics.php in core/modules/comment/src/CommentStatistics.php
ContentModerationStateInterface.php in core/modules/content_moderation/src/Entity/ContentModerationStateInterface.php
ContentTranslationHandler.php in core/modules/content_translation/src/ContentTranslationHandler.php
DefaultSelection.php in core/lib/Drupal/Core/Entity/Plugin/EntityReferenceSelection/DefaultSelection.php

... See full list

File

core/modules/user/src/EntityOwnerInterface.php, line 15

Namespace

Drupal\user
View source 
interface EntityOwnerInterface {
    
    /**
     * Returns the entity owner's user entity.
     *
     * @return \Drupal\user\UserInterface
     *   The owner user entity.
     */
    public function getOwner();
    
    /**
     * Sets the entity owner's user entity.
     *
     * @param \Drupal\user\UserInterface $account
     *   The owner user entity.
     *
     * @return $this
     */
    public function setOwner(UserInterface $account);
    
    /**
     * Returns the entity owner's user ID.
     *
     * @return int|null
     *   The owner user ID, or NULL in case the user ID field has not been set on
     *   the entity.
     */
    public function getOwnerId();
    
    /**
     * Sets the entity owner's user ID.
     *
     * @param int $uid
     *   The owner user id.
     *
     * @return $this
     */
    public function setOwnerId($uid);

}

Members

Title Modifiers Object type Summary Overrides
EntityOwnerInterface::getOwner public function Returns the entity owner's user entity. 1
EntityOwnerInterface::getOwnerId public function Returns the entity owner's user ID. 1
EntityOwnerInterface::setOwner public function Sets the entity owner's user entity. 1
EntityOwnerInterface::setOwnerId public function Sets the entity owner's user ID. 1

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.