hash_file

(PHP 5 >= 5.1.2, PHP 7, PHP 8, PECL hash >= 1.1)

hash_file — Генерирует хеш-значение на основе содержимого файла

Описание

hash_file(
    string $algo,
    string $filename,
    bool $binary = false,
    array $options = []
): string|false

Список параметров

algo

Название выбранного алгоритма хеширования (то есть "md5", "sha256", "haval160,4" и т. д.). Список поддерживаемых алгоритмов даёт описание функции hash_algos().

filename

URL-адрес, который описывает местоположение файла, который требуется захешировать; поддерживаются обёртки fopen.

binary

Если для параметра установили значение true, функция выводит необработанные двоичные данные. Если false — функция выводит символы в шестнадцатеричной кодировке в нижнем регистре.

options

Массив опций для алгоритмов хеширования. Пока вариантами функций хеширования MurmurHash поддерживается только параметр "seed".

Возвращаемые значения

Функция возвращает строку, которая содержит вычисленную хеш-подпись сообщения в виде строчных шестнадцатеричных символов в нижнем регистре, если только для параметра binary не установили значение true, тогда возвращается необработанное двоичное представление хеш-подписи сообщения.

Список изменений

Версия Описание
8.1.0 Добавили параметр options.

Примеры

Пример #1 Пример использования функции hash_file()

<?php

/* Создаём файл, чтобы вычислить его хеш */
file_put_contents('example.txt', 'The quick brown fox jumped over the lazy dog.');

echo hash_file('sha256', 'example.txt');

?>

Результат выполнения приведённого примера: 

68b1282b91de2c054c36629cb8dd447f12f096d3e3c587978dc2248444633483

Смотрите также

  • hash() - Генерирует хеш-значение (подпись сообщения)
  • hash_hmac_file() - Генерирует хеш-значение на основе ключа через метод HMAC и содержимое файла
  • hash_update_file() - Добавляет данные из файла в активный контекст хеширования
  • md5_file() - Возвращает MD5-хеш файла
  • sha1_file() - Возвращает SHA1-хеш файла