interface AccountInterface

Defines an account interface which represents the current user.

Defines an object that has a user id, roles and can have session data. The interface is implemented both by the global session and the user entity.

Hierarchy

Expanded class hierarchy of AccountInterface

All classes that implement AccountInterface

2 files declare their use of AccountInterface
Entity.php in drupal/core/lib/Drupal/Core/Entity/Entity.php
Contains \Drupal\Core\Entity\Entity.
user.module in drupal/core/modules/user/user.module
Enables the user registration and login system.

File

drupal/core/lib/Drupal/Core/Session/AccountInterface.php, line 16
Contains \Drupal\Core\Session\AccountInterface.

Namespace

Drupal\Core\Session
View source
interface AccountInterface {

  /**
   * Returns the user ID or 0 for anonymous.
   *
   * @return int
   *   The user ID.
   */
  public function id();

  /**
   * Returns a list of roles.
   *
   * @return array
   *   List of role IDs.
   */
  public function getRoles();

  /**
   * Returns the session ID.
   *
   * @return string|NULL
   *   The session ID or NULL if this user does not have an active session.
   */
  public function getSessionId();

  /**
   * Returns the secure session ID.
   *
   * @return string|NULL
   *   The session ID or NULL if this user does not have an active secure session.
   */
  public function getSecureSessionId();

  /**
   * Returns the session data.
   *
   * @return array
   *   Array with the session data that belongs to this object.
   */
  public function getSessionData();

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
AccountInterface::getRoles public function Returns a list of roles.
AccountInterface::getSecureSessionId public function Returns the secure session ID.
AccountInterface::getSessionData public function Returns the session data.
AccountInterface::getSessionId public function Returns the session ID.
AccountInterface::id public function Returns the user ID or 0 for anonymous.