file_put_contents
(PHP 5, PHP 7, PHP 8)
file_put_contents — Пише дані у файл
Опис
file_put_contents( string $filename, mixed $data, int $flags = 0, ?resource $context = null): int|false
Функція ідентична послідовним успішним викликам функцій fopen() fwrite() і fclose()
Якщо filename немає, файл буде створено. Інакше існуючий файл буде перезаписано, за винятком випадку, якщо вказано прапор FILE_APPEND
Список параметрів
filename
Шлях до файлу, що записується.
data
Дані, що записуються. Може бути типу string, array або ресурсом потоку.
Якщо data є потоковим ресурсом (stream), буфер цього потоку, що залишився, буде скопійований у зазначений файл. Це схоже на використання функції stream_copy_to_stream()
Також ви можете передати одновимірний масив як параметр data. Це буде еквівалентно виклику file_put_contents($filename, implode('', $array))
flags
Значением параметраflags може бути будь-яка комбінація наступних прапорів, з'єднаних бінарним оператором АБО (
Доступні прапори
| Флаг | Опис |
|---|---|
FILE_USE_INCLUDE_PATH | Шукає filename в директоріях, що підключаються. Детальніше дивіться директиву include_path |
FILE_APPEND | Якщо файл filename вже існує, дані будуть дописані в кінець файлу замість його перезаписати. |
LOCK_EX | Отримати ексклюзивне блокування файлу під час запису. Іншими словами, між викликами fopen() і fwrite() відбудеться виклик функції flock(). . Це не одне й те саме, що виклик fopen() з прапором "х". |
context
Коректний ресурс контексту, створений за допомогою функції stream_context_create()
Значення, що повертаються
Функція повертає кількість записаних байт у файл, або **false**в случае возникновения ошибки.
Увага
Ця функція може повертати як логічне значення **false**так і значення не типу boolean, яке наводиться до false. За більш детальною інформацією зверніться до розділу Логічний типИспользуйтеоператор === для перевірки значення, яке повертається цією функцією.
Приклади
Приклад #1 Приклад простого використання
Приклад #2 Використання прапорів
Примітки
Зауваження: Ця функція безпечна для обробки даних у двійковій формі.
Підказка
У цю функцію як ім'я файлу можна передавати URL-адреси, якщо була включена директива fopen wrappers. Докладніше про те, як вказати ім'я файлу, описано в описі функції fopen(). В розділі "Підтримувані протоколи та обгортки» також дано посилання на інформацію про можливості підтримуваних обгорток, зауваження щодо роботи з ними та список визначених змінних, які вони дають.
Дивіться також
- fopen() - Відкриває файл або URL
- fwrite() - Бінарно-безпечний запис у файл
- file_get_contents() - Читає вміст файлу в рядок
- stream_context_create() - Створює контекст потоку