interface HashServiceInterface in Fast Autocomplete 8

Interface HashServiceInterface.

Provides an interface defining a Fast Autocomplete hash service. The hash service is used to reduce the risk of information leakage by using a hash in the JSON files URL.

@package Drupal\fac

Hierarchy

• interface \Drupal\fac\HashServiceInterface

1 file declares its use of HashServiceInterface

FacController.php in src/Controller/FacController.php

File

src/HashServiceInterface.php, line 14

Namespace

Drupal\fac

interface HashServiceInterface {

  /**
   * Returns a hash.
   *
   * @return string
   *   The requested hash.
   */
  public function getHash();

  /**
   * Validates if the given hash is valid.
   *
   * @param string $hash
   *   The hash to validate.
   *
   * @return bool
   *   TRUE if the hash is valid. FALSE if the hash is invalid.
   */
  public function isValidHash($hash);

  /**
   * Returns the key used for getting a hash.
   *
   * @param bool $renewal
   *   If TRUE, the key is renewed.
   *
   * @return string
   *   The key.
   */
  public function getKey($renewal = FALSE);

}

Members

Name	Modifiers	Type	Description	Overrides
HashServiceInterface::getHash	public	function	Returns a hash.	1
HashServiceInterface::getKey	public	function	Returns the key used for getting a hash.	1
HashServiceInterface::isValidHash	public	function	Validates if the given hash is valid.	1