interface AuthenticationInterface in RESTful 7.2

Hierarchy

• interface \Drupal\restful\Plugin\authentication\AuthenticationInterface extends \Drupal\Component\Plugin\PluginInspectionInterface

File

src/Plugin/authentication/AuthenticationInterface.php, line 13

Contains \Drupal\restful\Plugin\authentication\Authentication

Namespace

Drupal\restful\Plugin\authentication

interface AuthenticationInterface extends PluginInspectionInterface {

  /**
   * Authenticate the request by trying to match a user.
   *
   * @param RequestInterface $request
   *   The request.
   *
   * @return object
   *   The user object.
   */
  public function authenticate(RequestInterface $request);

  /**
   * Determines if the request can be checked for authentication. For example,
   * when authenticating with HTTP header, return FALSE if the header values do
   * not exist.
   *
   * @param RequestInterface $request
   *   The request.
   *
   * @return bool
   *   TRUE if the request can be checked for authentication, FALSE otherwise.
   */
  public function applies(RequestInterface $request);

  /**
   * Get the name of the authentication plugin.
   *
   * @return string
   *   The name.
   */
  public function getName();

}

Members

Name	Modifiers	Type	Description	Overrides
AuthenticationInterface::applies	public	function	Determines if the request can be checked for authentication. For example, when authenticating with HTTP header, return FALSE if the header values do not exist.	1
AuthenticationInterface::authenticate	public	function	Authenticate the request by trying to match a user.	4
AuthenticationInterface::getName	public	function	Get the name of the authentication plugin.	1