PHP 8.4.0 RC4 available for testing

ZipArchive::addFromString

(PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL zip >= 1.1.0)

ZipArchive::addFromStringДобавляет содержимое в ZIP-архив как файл

Описание

public ZipArchive::addFromString(string $name, string $content, int $flags = ZipArchive::FL_OVERWRITE): bool

Метод добавляет содержимое в ZIP-архив как файл.

Замечание: Для максимальной переносимости, рекомендуется всегда пользоваться прямыми слешами / как разделителями директорий в именах файлов.

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

name

Название записи, которую требуется создать.

content

Содержимое в двоично безопасном режиме, из которого метод создаст файл в архиве.

flags

Битовая маска из следующих констант: ZipArchive::FL_OVERWRITE, ZipArchive::FL_ENC_GUESS, ZipArchive::FL_ENC_UTF_8, ZipArchive::FL_ENC_CP437. Поведение констант описывает страница «ZIP-константы».

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

Функция возвращает true в случае успешного выполнения или false, если возникла ошибка.

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

Версия Описание
8.0.0, PECL-модуль zip 1.18.0 Добавили параметр flags.

Примеры

Пример #1 Пример добавления записи в новый архив

<?php

$zip
= new ZipArchive();

$res = $zip->open('test.zip', ZipArchive::CREATE);

if (
$res === TRUE) {
$zip->addFromString('test.txt', 'В этом аргументе передаётся содержимое файла');
$zip->close();
echo
'Готово';
} else {
echo
'Ошибка';
}

?>

Пример #2 Пример добавления файла в каталог внутри архива

<?php

$zip
= new ZipArchive();

if (
$zip->open('test.zip') === TRUE) {
$zip->addFromString('dir/test.txt', 'В этом аргументе передаётся содержимое файла');
$zip->close();
echo
'Готово';
} else {
echo
'Ошибка';
}

?>
Добавить

Примечания пользователей 7 notes

up
12
Jacques Chester
17 years ago
Note that this function overwrites existing files of the same name.
up
8
gbti at ukr dot net
15 years ago
if you try:

<?php
$zip
->open("file", ZipArchive::CREATE);
$zip->addFromString("russian_letters/options.xml");
?>

wrong directory will be created.

if you try:

<?php
$zip
->addEmptyDir("russian_letters");
?>

All be fine.
up
6
tahazit dot co dot il at gmail dot com
9 years ago
On PHP >5.4, This function will usually create any subfolders inside the ZIP archive.
For instance:

$zip->addFromString ( 'path/to/file.txt' , $data );

will create the folders "path/", and "path/to/" in addition to placing the newly created file "file.txt" in "path/to/" folder.
up
4
xslidian at lidian dot info
11 years ago
Although numFiles will change after overwriting a file, it will be back normal when you ZipArchive::close() and open() it again.
NULL indexes don't persist either. Only the new order is kept. So feel free to overwrite.

Here overwriting works the same as deleting and adding. So it's not necessary to ZipArchive::deleteName() first.
up
2
hossam6 at gmail dot com
4 years ago
in case your string contain Arabic char, ZipArchive::addFromString will show it in wrong format char.
in this case you have to change your string coding from Unicode to Windows-1256 code

$filetxt = iconv('utf-8','CP1256',$filetxt);
$zip = new ZipArchive;
$zipFName = "Tmp.zip";
if ($zip->open($zipFName, ZipArchive::CREATE) === TRUE)
{
$zip->addFromString($fileName . '.csv', $filetxt);
$zip->close();
}
up
2
calebcjh
14 years ago
Although this function displaces files of the same name, in actual fact, the original file is blanked and a new entry is added. The numFiles property is incremented.

Example:

File 1: foo
File 2: bar

$zip->addFromString('foo', 'new foo');

File 1:
File 2: bar
File 3: foo
up
1
Jon at 9072997 dot com (yes that is real)
2 years ago
ZipArchive::FL_ENC_GUESS, ZipArchive::FL_ENC_UTF_8, and ZipArchive::FL_ENC_CP437 affect the $name parameter, not $content
To Top