Oauth2ClientInterface.php in Simple OAuth (OAuth2) & OpenID Connect 8.2

Namespace

Drupal\simple_oauth\Entity

File

src/Entity/Oauth2ClientInterface.php

<?php

namespace Drupal\simple_oauth\Entity;

use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\user\EntityOwnerInterface;
use Drupal\user\UserInterface;

/**
 * Provides an interface defining Access Token entities.
 *
 * @ingroup simple_oauth
 */
interface Oauth2ClientInterface extends ContentEntityInterface, EntityOwnerInterface {

  /**
   * Returns the hashed secret.
   *
   * @return string
   *   The secret password.
   */
  public function getSecret();

  /**
   * Sets the client secret.
   *
   * @param string $secret
   *   The new unhashed secret.
   *
   * @return \Drupal\simple_oauth\Entity\Oauth2ClientInterface
   *   The called client entity.
   */
  public function setSecret($secret);

  /**
   * Returns the entity default user's user entity.
   *
   * @return \Drupal\user\UserInterface
   *   The default user user entity.
   */
  public function getDefaultUser();

  /**
   * Sets the entity default user's user entity.
   *
   * @param \Drupal\user\UserInterface $account
   *   The default user user entity.
   *
   * @return $this
   */
  public function setDefaultUser(UserInterface $account);

  /**
   * Checks if the current entity is confidential.
   *
   * A confidential client is one that requires the secret to be validated.
   *
   * @return bool
   *   TRUE if it is confidential. FALSE otherwise.
   */
  public function isConfidential();

}

Interfaces

Name	Description
Oauth2ClientInterface	Provides an interface defining Access Token entities.