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

Название алгоритма хеширования (например, "sha256"). Список поддерживаемых алгоритмов даёт описание функции 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_init() - Инициализирует контекст инкрементного хеширования
  • hash_hmac_file() - Генерирует хеш-значение на основе ключа через метод HMAC и содержимое файла