PHP sha1_file() Function

The sha1_file() function is an inbuilt function in PHP which is used to generate the SHA-1 hash of the text file. This function returns a string on success and returns FALSE otherwise.

Syntax:

sha1_file ( $file, $raw )

Parameters Used: This function accepts two parameters as mentioned above and described below.

• $file: It is a mandatory parameter which specifies the file for SHA1 hash.
• $raw: It is an optional parameter which specifies boolean values.
  • TRUE – Raw 20 character binary format.
  • FALSE – By Default. 40 character long hex number.

Return Values: The function returns a string of SHA1 hash on success and returns FALSE otherwise.

Suppose there is a file named “gfg.txt” which has the below content.

Publish your
own articles and share
knowledge with
the world!!

Below programs illustrate the sha1_file() function.

Program 1:

<?php
// PHP  program to illustrate
// sha1_file() function

$gfg = sha1_file("gfg.txt");

echo $gfg;

?>

Output:

989aa47ec7ea68605dca25b499c8414e283e8354

Program 2: With optional parameter $raw with different values TRUE and FALSE.

<?php
// PHP  program to illustrate
// sha1_file() function

// Without optional parameter
echo sha1_file("gfg.txt") . "\n";

// with optional parameter $raw = FALSE (by default)
// no changes in result
echo sha1_file("gfg.txt", FALSE) . "\n";


// with optional parameter $raw = TRUE
// result changed
echo sha1_file("gfg.txt", TRUE) . "\n";

?>

Output:

989aa47ec7ea68605dca25b499c8414e283e8354
989aa47ec7ea68605dca25b499c8414e283e8354
???~??h`]?%???AN(>?T

Reference: http://php.net/manual/en/function.sha1-file.php