UriSigner
in package
Signs URIs.
Tags
Table of Contents
- $parameter : mixed
- $secret : mixed
- __construct() : mixed
- check() : bool
- Checks that a URI contains the correct hash.
- checkRequest() : bool
- sign() : string
- Signs a URI.
- buildUrl() : string
- computeHash() : string
Properties
$parameter
private
mixed
$parameter
$secret
private
mixed
$secret
Methods
__construct()
public
__construct(string $secret[, string $parameter = '_hash' ]) : mixed
Parameters
- $secret : string
-
A secret
- $parameter : string = '_hash'
-
Query string parameter to use
Return values
mixed —check()
Checks that a URI contains the correct hash.
public
check(string $uri) : bool
Parameters
- $uri : string
Return values
bool —checkRequest()
public
checkRequest(Request $request) : bool
Parameters
- $request : Request
Return values
bool —sign()
Signs a URI.
public
sign(string $uri) : string
The given URI is signed by adding the query string parameter which value depends on the URI and the secret.
Parameters
- $uri : string
Return values
string —buildUrl()
private
buildUrl(array<string|int, mixed> $url[, array<string|int, mixed> $params = [] ]) : string
Parameters
- $url : array<string|int, mixed>
- $params : array<string|int, mixed> = []
Return values
string —computeHash()
private
computeHash(string $uri) : string
Parameters
- $uri : string