Class Hash update

src/Create/Hash.php

@@ -10,9 +10,14 @@ namespace CoreLibs\Create;
 
 class Hash
 {
+	/** @var string default short hash -> deprecated use STANDARD_HASH_SHORT */
 	public const DEFAULT_HASH = 'adler32';
+	/** @var string default long hash (40 chars) */
 	public const STANDARD_HASH_LONG = 'ripemd160';
+	/** @var string default short hash (8 chars) */
 	public const STANDARD_HASH_SHORT = 'adler32';
+	/** @var string this is the standard hash to use hashStd and hash (64 chars) */
+	public const STANDARD_HASH = 'sha256';
 
 	/**
 	 * checks php version and if >=5.2.7 it will flip the string
@@ -20,6 +25,7 @@ class Hash
 	 * hash returns false
 	 * preg_replace fails for older php version
 	 * Use __hash with crc32b or hash('crc32b', ...) for correct output
+	 * For future short hashes use hashShort() instead
 	 *
 	 * @param  string $string string to crc
 	 * @return string         crc32b hash (old type)
@@ -43,19 +49,31 @@ class Hash
 	 * replacement for __crc32b call
 	 *
 	 * @param  string $string  string to hash
-	 * @param  bool   $use_sha use sha instead of crc32b (default false)
+	 * @param  bool   $use_sha use sha1 instead of crc32b (default false)
 	 * @return string          hash of the string
+	 * @deprecated use __crc32b() for drop in replacement with default, or sha1Short() for use sha true
 	 */
 	public static function __sha1Short(string $string, bool $use_sha = false): string
 	{
 		if ($use_sha) {
-			// return only the first 9 characters
-			return substr(hash('sha1', $string), 0, 9);
+			return self::sha1Short($string);
 		} else {
 			return self::__crc32b($string);
 		}
 	}
 
+	/**
+	 * returns a short sha1
+	 *
+	 * @param  string $string  string to hash
+	 * @return string          hash of the string
+	 */
+	public static function sha1Short(string $string): string
+	{
+		// return only the first 9 characters
+		return substr(hash('sha1', $string), 0, 9);
+	}
+
 	/**
 	 * replacemend for __crc32b call (alternate)
 	 * defaults to adler 32
@@ -65,32 +83,81 @@ class Hash
 	 * @param  string $string    string to hash
 	 * @param  string $hash_type hash type (default adler32)
 	 * @return string            hash of the string
+	 * @deprecated use hashShort() of short hashes with adler 32 or hash() for other hash types
 	 */
 	public static function __hash(
 		string $string,
-		string $hash_type = self::DEFAULT_HASH
+		string $hash_type = self::STANDARD_HASH_SHORT
+	): string {
+		return self::hash($string, $hash_type);
+	}
+
+	/**
+	 * creates a hash over string if any valid hash given.
+	 * if no hash type set use sha256
+	 *
+	 * @param  string $string    string to ash
+	 * @param  string $hash_type hash type (default sha256)
+	 * @return string            hash of the string
+	 */
+	public static function hash(
+		string $string,
+		string $hash_type = self::STANDARD_HASH
 	): string {
-		// if not empty, check if in valid list
 		if (
 			empty($hash_type) ||
 			!in_array($hash_type, hash_algos())
 		) {
 			// fallback to default hash type if none set or invalid
-			$hash_type = self::DEFAULT_HASH;
+			$hash_type = self::STANDARD_HASH;
 		}
 		return hash($hash_type, $string);
 	}
 
 	/**
-	 * Wrapper function for standard long hashd
+	 * short hash with max length of 8, uses adler32
+	 *
+	 * @param  string $string string to hash
+	 * @return string         hash of the string
+	 */
+	public static function hashShort(string $string): string
+	{
+		return hash(self::STANDARD_HASH_SHORT, $string);
+	}
+
+	/**
+	 * Wrapper function for standard long hash
+	 *
+	 * @param string $string String to be hashed
+	 * @return string        Hashed string
+	 * @deprecated use hashLong()
+	 */
+	public static function __hashLong(string $string): string
+	{
+		return self::hashLong($string);
+	}
+
+	/**
+	 * Wrapper function for standard long hash, uses ripmd160
 	 *
 	 * @param string $string String to be hashed
 	 * @return string        Hashed string
 	 */
-	public static function __hashLong(string $string): string
+	public static function hashLong(string $string): string
 	{
 		return hash(self::STANDARD_HASH_LONG, $string);
 	}
+
+	/**
+	 * create standard hash basd on STANDAR_HASH, currently sha256
+	 *
+	 * @param  string $string string in
+	 * @return string         hash of the string
+	 */
+	public static function hashStd(string $string): string
+	{
+		return self::hash($string, self::STANDARD_HASH);
+	}
 }
 
 // __END__