interface RestfulAuthenticationInterface in RESTful 7

@file Contains RestfulAuthenticationInterface.

Hierarchy

• interface \RestfulAuthenticationInterface

File

plugins/authentication/RestfulAuthenticationInterface.php, line 8

Contains RestfulAuthenticationInterface.

interface RestfulAuthenticationInterface {

  /**
   * Authenticate the request by trying to match a user.
   *
   * @param array $request
   *   The request.
   * @param string $method
   *   The HTTP method. Defaults to "get".
   *
   * @return \stdClass|null
   *   The user object.
   */
  public function authenticate(array $request = array(), $method = \RestfulInterface::GET);

  /**
   * 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 array $request
   *   The request.
   * @param string $method
   *   The HTTP method. Defaults to "get".
   *
   * @return bool
   *   TRUE if the request can be checked for authentication, FALSE otherwise.
   */
  public function applies(array $request = array(), $method = \RestfulInterface::GET);

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

}

Members

Name	Modifiers	Type	Description	Overrides
RestfulAuthenticationInterface::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
RestfulAuthenticationInterface::authenticate	public	function	Authenticate the request by trying to match a user.	3
RestfulAuthenticationInterface::getName	public	function	Get the name of the authentication plugin.	1