Php binary file write

Содержание

fwrite
Parameters
Return Values
Notes
Examples
See Also
fwrite
Parameters
Return Values
Errors/Exceptions
Changelog
Examples
Notes
See Also
User Contributed Notes 33 notes
fwrite
Список параметров
Возвращаемые значения
Примечания
Примеры
Смотрите также

fwrite

fwrite() writes the contents of string to the file stream pointed to by handle .

Parameters

A file system pointer resource that is typically created using fopen() .

The string that is to be written.

If the length argument is given, writing will stop after length bytes have been written or the end of string is reached, whichever comes first.

Note that if the length argument is given, then the magic_quotes_runtime configuration option will be ignored and no slashes will be stripped from string .

Return Values

fwrite() returns the number of bytes written, or FALSE on error.

Notes

Note:

Writing to a network stream may end before the whole string is written. Return value of fwrite() may be checked:

function fwrite_stream ( $fp , $string ) for ( $written = 0 ; $written < strlen ( $string ); $written += $fwrite ) $fwrite = fwrite ( $fp , substr ( $string , $written ));
if ( $fwrite === false ) return $written ;
>
>
return $written ;
>
?>

Note:

On systems which differentiate between binary and text files (i.e. Windows) the file must be opened with ‘b’ included in fopen() mode parameter.

Note:

If handle was fopen() ed in append mode, fwrite() s are atomic (unless the size of string exceeds the filesystem’s block size, on some platforms, and as long as the file is on a local filesystem). That is, there is no need to flock() a resource before calling fwrite() ; all of the data will be written without interruption.

Note:

If writing twice to the file pointer, then the data will be appended to the end of the file content:

$fp = fopen ( ‘data.txt’ , ‘w’ );
fwrite ( $fp , ‘1’ );
fwrite ( $fp , ’23’ );
fclose ( $fp );

// the content of ‘data.txt’ is now 123 and not 23!
?>

Examples

Example #1 A simple fwrite() example

$filename = ‘test.txt’ ;
$somecontent = «Add this to the file\n» ;

// Let’s make sure the file exists and is writable first.
if ( is_writable ( $filename ))

// In our example we’re opening $filename in append mode.
// The file pointer is at the bottom of the file hence
// that’s where $somecontent will go when we fwrite() it.
if (! $handle = fopen ( $filename , ‘a’ )) echo «Cannot open file ( $filename )» ;
exit;
>

// Write $somecontent to our opened file.
if ( fwrite ( $handle , $somecontent ) === FALSE ) echo «Cannot write to file ( $filename )» ;
exit;
>

echo «Success, wrote ( $somecontent ) to file ( $filename )» ;

> else echo «The file $filename is not writable» ;
>
?>

fwrite

fwrite() writes the contents of data to the file stream pointed to by stream .

Parameters

A file system pointer resource that is typically created using fopen() .

The string that is to be written.

If length is an int , writing will stop after length bytes have been written or the end of data is reached, whichever comes first.

Return Values

fwrite() returns the number of bytes written, or false on failure.

Errors/Exceptions

fwrite() raises E_WARNING on failure.

Changelog

Examples

Example #1 A simple fwrite() example

$filename = ‘test.txt’ ;
$somecontent = «Add this to the file\n» ;

// Let’s make sure the file exists and is writable first.
if ( is_writable ( $filename ))

// In our example we’re opening $filename in append mode.
// The file pointer is at the bottom of the file hence
// that’s where $somecontent will go when we fwrite() it.
if (! $fp = fopen ( $filename , ‘a’ )) echo «Cannot open file ( $filename )» ;
exit;
>

// Write $somecontent to our opened file.
if ( fwrite ( $fp , $somecontent ) === FALSE ) echo «Cannot write to file ( $filename )» ;
exit;
>

echo «Success, wrote ( $somecontent ) to file ( $filename )» ;

> else echo «The file $filename is not writable» ;
>
?>

Notes

Note:

Writing to a network stream may end before the whole string is written. Return value of fwrite() may be checked:

Note:

On systems which differentiate between binary and text files (i.e. Windows) the file must be opened with ‘b’ included in fopen() mode parameter.

Note:

If stream was fopen() ed in append mode, fwrite() s are atomic (unless the size of data exceeds the filesystem’s block size, on some platforms, and as long as the file is on a local filesystem). That is, there is no need to flock() a resource before calling fwrite() ; all of the data will be written without interruption.

Note:

If writing twice to the file pointer, then the data will be appended to the end of the file content:

$fp = fopen ( ‘data.txt’ , ‘w’ );
fwrite ( $fp , ‘1’ );
fwrite ( $fp , ’23’ );
fclose ( $fp );

// the content of ‘data.txt’ is now 123 and not 23!
?>

User Contributed Notes 33 notes

After having problems with fwrite() returning 0 in cases where one would fully expect a return value of false, I took a look at the source code for php’s fwrite() itself. The function will only return false if you pass in invalid arguments. Any other error, just as a broken pipe or closed connection, will result in a return value of less than strlen($string), in most cases 0.

Therefore, looping with repeated calls to fwrite() until the sum of number of bytes written equals the strlen() of the full value or expecting false on error will result in an infinite loop if the connection is lost.

This means the example fwrite_stream() code from the docs, as well as all the «helper» functions posted by others in the comments are all broken. You *must* check for a return value of 0 and either abort immediately or track a maximum number of retries.

Below is the example from the docs. This code is BAD, as a broken pipe will result in fwrite() infinitely looping with a return value of 0. Since the loop only breaks if fwrite() returns false or successfully writes all bytes, an infinite loop will occur on failure.

// BROKEN function — infinite loop when fwrite() returns 0s
function fwrite_stream ( $fp , $string ) <
for ( $written = 0 ; $written < strlen ( $string ); $written += $fwrite ) <
$fwrite = fwrite ( $fp , substr ( $string , $written ));
if ( $fwrite === false ) <
return $written ;
>
>
return $written ;
>
?>

if you need a function that writes all data, maybe try

/**
* writes all data or throws
*
* @param mixed $handle
* @param string $data
* @throws \RuntimeException when fwrite returned * @return void
*/
/*private static*/ function fwrite_all ( $handle , string $data ): void
$original_len = strlen ( $data );
if ( $original_len > 0 ) $len = $original_len ;
$written_total = 0 ;
for (;;) $written_now = fwrite ( $handle , $data );
if ( $written_now === $len ) return;
>
if ( $written_now < 1 ) throw new \ RuntimeException ( "could only write < $written_total >/ < $original_len >bytes!» );
>
$written_total += $written_now ;
$data = substr ( $data , $written_now );
$len -= $written_now ;
// assert($len > 0);
// assert($len === strlen($data));
>
>
>

$handles can also be used to output in console like below example

fwrite(STDOUT, «Console Output»);

Источник

fwrite

fwrite() записывает содержимое string в файловый поток handle .

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

Указатель ( resource ) на файл, обычно создаваемый с помощью функции fopen() .

Если передан аргумент length , запись остановится после того, как length байтов будут записаны или будет достигнут конец строки string , смотря что произойдёт первым.

Учтите, что если указан аргумент length , то директива magic_quotes_runtime будет проигнорирована и строка string не будет очищена от слешей.

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

fwrite() возвращает количество записанных байт или FALSE в случае ошибки.

Примечания

Замечание:

Запись в сетевой поток может прекратиться до того, как будут записаны все данные. Это можно контролировать с помощью проверки возвращаемого значения функции fwrite() :

Замечание:

В системах, различающих двоичные и текстовые файлы (к примеру, Windows), файл должен быть открыт используя флаг ‘b’ в конце аргумента mode функции fopen() .

Замечание:

Если дескриптор handle был открыт функцией fopen() в режиме «записи в конец», то вызовы fwrite() будут атомарными (за исключением случая, если string размер блока файловой системы, на некоторых платформах, и пока файл хранится на локальной файловой системе). Т.е. нет необходимости блокировать ресурс с помощью flock() перед вызовом fwrite() — все данные будут записаны без прерываний.

Замечание:

При повторной записи в файловый указатель данные будут добавлены в конец содержимого файла:

$fp = fopen ( ‘data.txt’ , ‘w’ );
fwrite ( $fp , ‘1’ );
fwrite ( $fp , ’23’ );
fclose ( $fp );

// содержимое ‘data.txt’ теперь 123, а не 23!
?>

Примеры

Пример #1 Простой пример использования fwrite()

$filename = ‘test.txt’ ;
$somecontent = «Добавить это к файлу\n» ;

// Вначале давайте убедимся, что файл существует и доступен для записи.
if ( is_writable ( $filename ))

// В нашем примере мы открываем $filename в режиме «записи в конец».
// Таким образом, смещение установлено в конец файла и
// наш $somecontent допишется в конец при использовании fwrite().
if (! $handle = fopen ( $filename , ‘a’ )) echo «Не могу открыть файл ( $filename )» ;
exit;
>

// Записываем $somecontent в наш открытый файл.
if ( fwrite ( $handle , $somecontent ) === FALSE ) echo «Не могу произвести запись в файл ( $filename )» ;
exit;
>

echo «Ура! Записали ( $somecontent ) в файл ( $filename )» ;

> else echo «Файл $filename недоступен для записи» ;
>
?>

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

fread() — Бинарно-безопасное чтение файла
fopen() — Открывает файл или URL
fsockopen() — Открывает соединение с интернет сокетом или доменным сокетом Unix
popen() — Открывает файловый указатель процесса
file_get_contents() — Читает содержимое файла в строку

Источник

Php binary file write

fwrite

Parameters

Return Values

Notes

Examples

See Also

fwrite

Parameters

Return Values

Errors/Exceptions

Changelog

Examples

Notes

See Also

User Contributed Notes 33 notes

fwrite

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

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

Примечания

Примеры

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