Added some documentation

This commit is contained in:
Michael Vogel 2016-02-03 05:00:26 +01:00
parent f604f13d7d
commit 47d2e3b142

View file

@ -773,13 +773,25 @@ function item_add_language_opt(&$arr) {
} }
} }
/**
* @brief Creates an unique guid out of a given uri
*
* @param string $uri uri of an item entry
* @return string unique guid
*/
function uri_to_guid($uri) { function uri_to_guid($uri) {
// Our regular guid routine is using this kind of prefix as well
// We have to avoid that different routines could accidentally create the same value
$parsed = parse_url($uri); $parsed = parse_url($uri);
$guid_prefix = hash("crc32", $parsed["host"]); $guid_prefix = hash("crc32", $parsed["host"]);
// Remove the scheme to make sure that "https" and "http" doesn't make a difference
unset($parsed["scheme"]); unset($parsed["scheme"]);
$host_id = implode("/", $parsed); $host_id = implode("/", $parsed);
// We could use any hash algorithm since it isn't a security issue
$host_hash = hash("ripemd128", $host_id); $host_hash = hash("ripemd128", $host_id);
return $guid_prefix.$host_hash; return $guid_prefix.$host_hash;