Возвращает false и ошибку если файл уже существует

(PHP 4, PHP 5, PHP 7, PHP 8)

fopenОткрывает файл или URL

Описание

fopen(
    string $filename,
    string $mode,
    bool $use_include_path = false,
    ?resource $context = null
): resource|false

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

filename

Если filename передан в форме «scheme://…»,
он считается URL и PHP проведёт поиск обработчика протокола
(также известного как «обёртка») для этой схемы. Если ни одна
обёртка не закреплена за протоколом, PHP выдаст замечание,
чтобы помочь вам отследить потенциальную проблему в вашем
скрипте и затем продолжит выполнение, как если бы filename
указывал на обыкновенный файл.

Если PHP установлено, что filename указывает на
локальный файл, тогда выполняется попытка открыть поток к этому файлу.
Файл должен быть доступен PHP, так что вам следует убедиться,
что права доступа на файл это разрешают.
Если вы включили open_basedir, то накладываются
дальнейшие ограничения.

Если PHP установил, что filename указывает на
зарегистрированный протокол и этот протокол зарегистрирован как
сетевой URL, PHP выполняет проверку состояния директивы
allow_url_fopen.
Если она выключена, PHP выдаст предупреждение и вызов fopen закончится
неудачей.

Замечание:

Список поддерживаемых протоколов доступен в разделе Поддерживаемые протоколы и обёртки.
Некоторые протоколы (обёртки) поддерживают
контекст и/или опции php.ini.
Обратитесь к соответствующей странице с описанием используемого протокола
для получения списка опций, которые могут быть установлены.
(например, значение php.ini user_agent используется
обёрткой http).

На платформе Windows, необходимо экранировать все
обратные слеши в пути к файлу или использовать прямые слеши.

<?php
$handle
= fopen("c:\\folder\\resource.txt", "r");
?>

mode

Параметр mode указывает тип доступа, который вы
запрашиваете у потока. Он может быть одним из следующих вариантов:


Список возможных режимов для fopen(),
используя mode

mode Описание
'r' Открывает файл только для чтения; помещает указатель
в начало файла.
'r+' Открывает файл для чтения и записи; помещает указатель
в начало файла.
'w' Открывает файл только для записи; в противном случае ведёт
себя так же, как и 'w+'.
'w+' Открывает файл для чтения и записи; помещает указатель
в начало файла и обрезает файл до нулевой длины.
Если файл не существует — пытается его создать.
'a' Открывает файл только для записи; помещает указатель в конец
файла. Если файл не существует — пытается его создать.
В данном режиме функция fseek() не применима, записи всегда добавляются в конец.
'a+' Открывает файл для чтения и записи; помещает указатель в конец
файла. Если файл не существует — пытается его создать. В данном режиме функция fseek() влияет только на позицию чтения, записи всегда добавляются в конец.
'x' Создаёт и открывает только для записи; помещает указатель в
начало файла. Если файл уже существует, вызов
fopen() закончится неудачей, вернёт false и
выдаст ошибку уровня E_WARNING.
Если файл не существует, попытается его создать. Это эквивалентно
указанию флагов O_EXCL|O_CREAT для внутреннего
системного вызова open(2).
'x+' Создаёт и открывает для чтения и записи; в остальном имеет то же поведение, что и'x'.
'c' Открывает файл только для записи. Если файл не существует, то он создаётся.
Если же файл существует, то он не обрезается (в отличие от
'w'), и вызов к этой функции не вызывает ошибку (также как
и в случае с 'x'). Указатель на файл будет установлен
на начало файла. Это может быть полезно при желании заблокировать
файл (смотрите flock()) перед изменением, так как использование
'w' может обрезать файл ещё до того как была получена блокировка
(если вы желаете обрезать файл, можно использовать функцию
ftruncate() после запроса на блокировку).
'c+' Открывает файл для чтения и записи; в остальном имеет то же поведение, что и 'c'.
'e' Установить флаг close-on-exec (закрыть при запуске) на открытый файловый
дескриптор. Доступно только в PHP скомпилированном на системах
поддерживающих POSIX.1-2008.

Замечание:

Разные семейства операционных систем имеют разные соглашения
относительно окончания строк. Когда вы пишете текст и хотите вставить
разрыв строки, вы должны использовать правильные символы (или символ) для
вашей операционной системы. Системы семейства Unix используют
\n в качестве символа конца строки, системы
семейства Windows используют \r\n в качестве
символов окончания строки и системы семейства Macintosh (Mac OS Classic) используют
\r в качестве символа конца строки.

Если вы используете неверный символ конца строки при редактировании
файлов, вы можете обнаружить, что при открытии эти файлы «странно
выглядят».

Windows предлагает флаг режима текстовой трансляции
('t'), который автоматически переведёт
\n в \r\n во время работы с файлом.
И наоборот — вы также можете использовать 'b', чтобы
принудительно включить бинарный режим, в котором ваши данные
не будут преобразовываться. Чтобы использовать эти режимы, укажите
'b' или 't' последней
буквой параметра mode.

Флагом трансляции по умолчанию является 'b'.
Вы можете использовать режим
't', если работаете с текстовыми файлами и
используете \n для обозначения
конца строки в вашем скрипте, но при этом предполагаете,
что ваши файлы будут использоваться в таких приложениях, как «Блокнот» (в устаревших версиях).
Во всех остальных случаях используйте флаг 'b'.

Если вы укажете флаг ‘t’ во время работы с бинарными файлами,
вы можете столкнуться со странными проблемами с вашими данными, включая
повреждённые файлы изображений и проблемы с символами \r\n.

Замечание:

Опять же из соображений портируемости крайне
рекомендуется переписать старый код, который полагается на режим
't', чтобы вместо этого он использовал правильные
концы строк и режим 'b'.

Замечание:

Параметр mode игнорируется при работе с
обёртками потока php://output,
php://input, php://stdin,
php://stdout, php://stderr и
php://fd.

use_include_path

Необязательный третий параметр use_include_path
может быть установлен в ‘1’ или true, если вы также хотите провести
поиск файла в include_path.

context

Ресурс (resource) с контекстом потока.

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

Возвращает указатель на файл в случае успешного выполнения или false в случае возникновения ошибки

Ошибки

В случае неудачного завершения работы генерируется ошибка уровня E_WARNING.

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

Версия Описание
7.0.16, 7.1.2 Добавлена опция 'e'.

Примеры

Пример #1 Примеры использования fopen()

<?php
$handle
= fopen("/home/rasmus/file.txt", "r");
$handle = fopen("/home/rasmus/file.gif", "wb");
$handle = fopen("http://www.example.com/", "r");
$handle = fopen("ftp://user:password@example.com/somefile.txt", "w");
?>

Примечания

Внимание

При использовании SSL, Microsoft IIS нарушает протокол, закрывая соединение без отправки индикатора close_notify. PHP сообщит об этом как «SSL: Fatal Protocol Error» в тот момент, когда вы достигнете конца данных. Чтобы обойти это, вы должны установить error_reporting на уровень, исключающий E_WARNING. PHP умеет определять, что на стороне сервера находится проблемный IIS при открытии потока с помощью обёртки https:// и не выводит предупреждение. Если вы используете fsockopen() для создания ssl:// сокета, вы сами отвечаете за определение и подавление этого предупреждения.

Замечание:

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

Замечание:

Данная функция также может принимать директории в качестве параметра filename.
Если вы не знаете, является ли filename файлом или директорией,
то вам может понадобиться использовать функцию is_dir()
до вызова функции fopen().

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

  • Поддерживаемые протоколы и обёртки
  • fclose() — Закрывает открытый дескриптор файла
  • fgets() — Читает строку из файла
  • fread() — Бинарно-безопасное чтение файла
  • fwrite() — Бинарно-безопасная запись в файл
  • fsockopen() — Открывает соединение с интернет-сокетом или доменным сокетом Unix
  • file() — Читает содержимое файла и помещает его в массив
  • file_exists() — Проверяет существование указанного файла или каталога
  • is_readable() — Определяет существование файла и доступен ли он для чтения
  • stream_set_timeout() — Установить значение времени ожидания для потока
  • popen() — Открывает файловый указатель процесса
  • stream_context_create() — Создаёт контекст потока
  • umask() — Изменяет текущую umask
  • SplFileObject

chapman at worldtakeoverindustries dot com

11 years ago

Note - using fopen in 'w' mode will NOT update the modification time (filemtime) of a file like you may expect. You may want to issue a touch() after writing and closing the file which update its modification time. This may become critical in a caching situation, if you intend to keep your hair.

Anon.

2 years ago

/***** GENTLE REMINDER *****/
Really important. Do NOT use the "w" flag unless you want to delete everything in the file.

php at delhelsa dot com

15 years ago

With php 5.2.5 on Apache 2.2.4, accessing files on an ftp server with fopen() or readfile() requires an extra forwardslash if an absolute path is needed.

i.e., if a file called bullbes.txt is stored under /var/school/ on ftp server example.com and you're trying to access it with user blossom and password buttercup, the url would be:

ftp://blossom:buttercup@example.com//var/school/bubbles.txt

Note the two forwardslashes. It looks like the second one is needed so the server won't interpret the path as relative to blossom's home on townsville.

petepostma-deletethis at gmail dot com

6 years ago

The verbal descriptions take a while to read through to get a feel for the expected results for fopen modes. This csv table can help break it down for quicker understanding to find which mode you are looking for:

Mode,Creates,Reads,Writes,Pointer Starts,Truncates File,Notes,Purpose
r,,y,,beginning,,fails if file doesn't exist,basic read existing file
r+,,y,y,beginning,,fails if file doesn't exist,basic r/w existing file
w,y,,y,beginning+end,y,,"create, erase, write file"
w+,y,y,y,beginning+end,y,,"create, erase, write file with read option"
a,y,,y,end,,,"write from end of file, create if needed"
a+,y,y,y,end,,,"write from end of file, create if needed, with read options"
x,y,,y,beginning,,fails if file exists,"like w, but prevents over-writing an existing file"
x+,y,y,y,beginning,,fails if file exists,"like w+, but prevents over writing an existing file"
c,y,,y,beginning,,,open/create a file for writing without deleting current content
c+,y,y,y,beginning,,,"open/create a file that is read, and then written back down"

php-manual at merlindynamics dot com

3 years ago

There is an undocumented mode for making fopen non-blocking (not working on windows). By adding 'n' to the mode parameter, fopen will not block, however if the pipe does not exist an error will be raised.

$fp = fopen("/tmp/debug", "a"); //blocks if pipe does not exist

$fp = fopen("/tmp/debug", "an"); //raises error on pipe not exist

durwood at speakeasy dot NOSPAM dot net

18 years ago

I couldn't for the life of me get a certain php script working when i moved my server to a new Fedora 4 installation. The problem was that fopen() was failing when trying to access a file as a URL through apache -- even though it worked fine when run from the shell and even though the file was readily readable from any browser. After trying to place blame on Apache, RedHat, and even my cat and dog, I finally ran across this bug report on Redhat's website:

https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=164700

Basically the problem was SELinux (which I knew nothing about) -- you have to run the following command in order for SELinux to allow php to open a web file:

/usr/sbin/setsebool httpd_can_network_connect=1

To make the change permanent, run it with the -P option:

/usr/sbin/setsebool -P httpd_can_network_connect=1

Hope this helps others out -- it sure took me a long time to track down the problem.

ideacode

18 years ago

Note that whether you may open directories is operating system dependent. The following lines:

<?php
// Windows ($fh === false)
$fh = fopen('c:\\Temp', 'r');// UNIX (is_resource($fh) === true)
$fh = fopen('/tmp', 'r');
?>

demonstrate that on Windows (2000, probably XP) you may not open a directory (the error is "Permission Denied"), regardless of the security permissions on that directory.

On UNIX, you may happily read the directory format for the native filesystem.

dan at cleandns dot com

19 years ago

<?php
#going to update last users counter script since
#aborting a write because a file is locked is not correct.
$counter_file = '/tmp/counter.txt';
clearstatcache();
ignore_user_abort(true); ## prevent refresh from aborting file operations and hosing file
if (file_exists($counter_file)) {
$fh = fopen($counter_file, 'r+');
while(
1) {
if (
flock($fh, LOCK_EX)) {
#$buffer = chop(fgets($fh, 2));
$buffer = chop(fread($fh, filesize($counter_file)));
$buffer++;
rewind($fh);
fwrite($fh, $buffer);
fflush($fh);
ftruncate($fh, ftell($fh));
flock($fh, LOCK_UN);
break;
}
}
}
else {
$fh = fopen($counter_file, 'w+');
fwrite($fh, "1");
$buffer="1";
}
fclose($fh);

print

"Count is $buffer";?>

php at richardneill dot org

12 years ago

fopen() will block if the file to be opened is a fifo. This is true whether it's opened in "r" or "w" mode. (See man 7 fifo: this is the correct, default behaviour; although Linux supports non-blocking fopen() of a fifo, PHP doesn't).
The consequence of this is that you can't discover whether an initial fifo read/write would block because to do that you need stream_select(), which in turn requires that fopen() has happened!

etters dot ayoub at gmail dot com

5 years ago

This functions check recursive permissions and recursive existence parent folders, before creating a folder. To avoid the generation of errors/warnings.

/**
* This functions check recursive permissions and recursive existence parent folders,
* before creating a folder. To avoid the generation of errors/warnings.
*
* @return bool
* true folder has been created or exist and writable.
* False folder not exist and cannot be created.
*/
function createWritableFolder($folder)
{
if (file_exists($folder)) {
// Folder exist.
return is_writable($folder);
}
// Folder not exit, check parent folder.
$folderParent = dirname($folder);
if($folderParent != '.' && $folderParent != '/' ) {
if(!createWritableFolder(dirname($folder))) {
// Failed to create folder parent.
return false;
}
// Folder parent created.
}

if ( is_writable($folderParent) ) {
// Folder parent is writable.
if ( mkdir($folder, 0777, true) ) {
// Folder created.
return true;
}
// Failed to create folder.
}
// Folder parent is not writable.
return false;
}

/**
* This functions check recursive permissions and recursive existence parent folders,
* before creating a file/folder. To avoid the generation of errors/warnings.
*
* @return bool
* true has been created or file exist and writable.
* False file not exist and cannot be created.
*/
function createWritableFile($file)
{
// Check if conf file exist.
if (file_exists($file)) {
// check if conf file is writable.
return is_writable($file);
}

// Check if conf folder exist and try to create conf file.
if(createWritableFolder(dirname($file)) && ($handle = fopen($file, 'a'))) {
fclose($handle);
return true; // File conf created.
}
// Inaccessible conf file.
return false;
}

splogamurugan at gmail dot com

12 years ago

While opening a file with multibyte data (Ex: données multi-octets), faced some issues with the encoding. Got to know that it uses windows-1250. Used iconv to convert it to UTF-8 and it resolved the issue.

<?php

function utf8_fopen_read($fileName) {

$fc = iconv('windows-1250', 'utf-8', file_get_contents($fileName));

$handle=fopen("php://memory", "rw");

fwrite($handle, $fc);

fseek($handle, 0);

return
$handle;

}

?>



Example usage:

<?php

$fh
= utf8_fopen_read("./tpKpiBundle.csv");

while ((
$data = fgetcsv($fh, 1000, ",")) !== false) {

foreach (
$data as $value) {

echo
$value . "<br />\n";

}

}

?>



Hope it helps.

info at b1g dot de

17 years ago

Simple class to fetch a HTTP URL. Supports "Location:"-redirections. Useful for servers with allow_url_fopen=false. Works with SSL-secured hosts.

<?php

#usage:

$r = new HTTPRequest('http://www.example.com');

echo
$r->DownloadToString();

class

HTTPRequest

{

var
$_fp; // HTTP socket

var $_url; // full URL

var $_host; // HTTP host

var $_protocol; // protocol (HTTP/HTTPS)

var $_uri; // request URI

var $_port; // port

// scan url

function _scan_url()

{

$req = $this->_url;
$pos = strpos($req, '://');

$this->_protocol = strtolower(substr($req, 0, $pos));
$req = substr($req, $pos+3);

$pos = strpos($req, '/');

if(
$pos === false)

$pos = strlen($req);

$host = substr($req, 0, $pos);

if(

strpos($host, ':') !== false)

{

list(
$this->_host, $this->_port) = explode(':', $host);

}

else

{

$this->_host = $host;

$this->_port = ($this->_protocol == 'https') ? 443 : 80;

}
$this->_uri = substr($req, $pos);

if(
$this->_uri == '')

$this->_uri = '/';

}
// constructor

function HTTPRequest($url)

{

$this->_url = $url;

$this->_scan_url();

}
// download URL to string

function DownloadToString()

{

$crlf = "\r\n";
// generate request

$req = 'GET ' . $this->_uri . ' HTTP/1.0' . $crlf

. 'Host: ' . $this->_host . $crlf

. $crlf;
// fetch

$this->_fp = fsockopen(($this->_protocol == 'https' ? 'ssl://' : '') . $this->_host, $this->_port);

fwrite($this->_fp, $req);

while(
is_resource($this->_fp) && $this->_fp && !feof($this->_fp))

$response .= fread($this->_fp, 1024);

fclose($this->_fp);
// split header and body

$pos = strpos($response, $crlf . $crlf);

if(
$pos === false)

return(
$response);

$header = substr($response, 0, $pos);

$body = substr($response, $pos + 2 * strlen($crlf));
// parse headers

$headers = array();

$lines = explode($crlf, $header);

foreach(
$lines as $line)

if((
$pos = strpos($line, ':')) !== false)

$headers[strtolower(trim(substr($line, 0, $pos)))] = trim(substr($line, $pos+1));
// redirection?

if(isset($headers['location']))

{

$http = new HTTPRequest($headers['location']);

return(
$http->DownloadToString($http));

}

else

{

return(
$body);

}

}

}

?>

apathetic012 at gmail dot com

11 years ago

a variable $http_response_header is available when doing the fopen(). Which contains an array of the response header.

Derrick

8 months ago

Opening a file in "r+" mode, and then trying to set the file pointer position with ftruncate before reading the file will result in file data loss, as though you opened the file in "w" mode.

EX:

$File = fopen($FilePath,"r+"); // OPEN FILE IN READ-WRITE

ftruncate($File, 0); // SET POINTER POSITION (Will Erase Data)

while(! feof($File)) { // CONTINUE UNTIL END OF FILE IS REACHED

$Line = fgets($File); // GET A LINE FROM THE FILE INTO STRING
$Line = trim($Line); // TRIM STRING OF NEW LINE
}

ftruncate($File,0); // (Will Not Erase Data)

fclose($File);

wvss at gmail dot com

1 year ago

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head>
<body>
<?php
// generiereHostliste.phpfunction generiereHostliste($file) {// aus Rechnerliste.csv lesen
$fp = fopen($file, "r");
while(
$row = fgetcsv($fp, 0, ";")) {
$liste[]=[$row[0].";10.16.".$row[1].".".$row[2]];

}

fclose($fp);// in Hostliste.csv schreiben
$fp = fopen("Hostliste.csv", "w");
foreach(
$liste as $row) {
echo
"<pre>";
print_r($row);
echo
"</pre>";
fputcsv($fp, $row, ";");
}
fclose($fp);
}
// Test
$file = "Rechnerliste.csv";
generiereHostliste($file);?>
</body>
</html>

ken dot gregg at rwre dot com

19 years ago

PHP will open a directory if a path with no file name is supplied. This just bit me. I was not checking the filename part of a concatenated string.

For example:

<?php

$fd
= fopen('/home/mydir/' . $somefile, 'r');

?>



Will open the directory if $somefile = ''

If you attempt to read using the file handle you will get the binary directory contents. I tried append mode and it errors out so does not seem to be dangerous.

This is with FreeBSD 4.5 and PHP 4.3.1. Behaves the same on 4.1.1 and PHP 4.1.2. I have not tested other version/os combinations.

flobee

17 years ago

download: i need a function to simulate a "wget url" and do not buffer the data in the memory to avoid thouse problems on large files:
<?php
function download($file_source, $file_target) {
$rh = fopen($file_source, 'rb');
$wh = fopen($file_target, 'wb');
if (
$rh===false || $wh===false) {
// error reading or opening file
return true;
}
while (!
feof($rh)) {
if (
fwrite($wh, fread($rh, 1024)) === FALSE) {
// 'Download error: Cannot write to file ('.$file_target.')';
return true;
}
}
fclose($rh);
fclose($wh);
// No error
return false;
}
?>

kasper at webmasteren dot eu

11 years ago

"Do not use the following reserved device names for the name of a file:
CON, PRN, AUX, NUL, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, LPT1,
LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, and LPT9. Also avoid these names
followed immediately by an extension; for example, NUL.txt is not recommended.
For more information, see Namespaces"
it is a windows limitation.
see:
http://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx

keithm at aoeex dot NOSPAM dot com

22 years ago

I was working on a consol script for win32 and noticed a few things about it. On win32 it appears that you can't re-open the input stream for reading, but rather you have to open it once, and read from there on. Also, i don't know if this is a bug or what but it appears that fgets() reads until the new line anyway. The number of characters returned is ok, but it will not halt reading and return to the script. I don't know of a work around for this right now, but i'll keep working on it.

This is some code to work around the close and re-open of stdin.

<?php

function read($length='255'){

if (!isset(
$GLOBALS['StdinPointer'])){

$GLOBALS['StdinPointer']=fopen("php://stdin","r");

}

$line=fgets($GLOBALS['StdinPointer'],$length);

return
trim($line);

}

echo
"Enter your name: ";

$name=read();

echo
"Enter your age: ";

$age=read();

echo
"Hi $name, Isn't it Great to be $age years old?";

@
fclose($StdinPointer);

?>

ceo at l-i-e dot com

17 years ago

If you need fopen() on a URL to timeout, you can do like:
<?php
$timeout
= 3;
$old = ini_set('default_socket_timeout', $timeout);
$file = fopen('http://example.com', 'r');
ini_set('default_socket_timeout', $old);
stream_set_timeout($file, $timeout);
stream_set_blocking($file, 0);
//the rest is standard
?>

wvss at gmail dot com

1 year ago

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head>
<body>
<?php
// generiereHostliste.phpfunction generiereHostliste($file) {// aus Rechnerliste.csv lesen
$fp = fopen($file, "r");
while(
$row = fgetcsv($fp, 0, ";")) {
$liste[]=[$row[0].";10.16.".$row[1].".".$row[2]];

}

fclose($fp);// in Hostliste.csv schreiben
$fp = fopen("Hostliste.csv", "w");
foreach(
$liste as $row) {
echo
"<pre>";
print_r($row);
echo
"</pre>";
fputcsv($fp, $row, ";");
}
fclose($fp);
}
// Test
$file = "Rechnerliste.csv";
generiereHostliste($file);?>
</body>
</html>

k-gun at git dot io

3 years ago

Seems not documented here but keep in mind, when $filename contains null byte (\0) then a TypeError will be thrown with message such;

TypeError: fopen() expects parameter 1 to be a valid path, string given in ...

sean downey

15 years ago

when using ssl / https on windows i would get the error:

"Warning: fopen(https://example.com): failed to open stream: Invalid argument in someSpecialFile.php on line 4344534"

This was because I did not have the extension "php_openssl.dll" enabled.

So if you have the same problem, goto your php.ini file and enable it :)


В этой уроке мы рассмотрим несколько функций, с помощью которых будем открывать, читать и закрывать файлы на сервере.


Функция PHP fopen()

Функция fopen() в PHP — это встроенная функция, которая используется для открытия файла или URL-адреса. В случае сбоя, она возвращает FALSE и выдаёт ошибку. Если вам нужно скрыть вывод ошибки добавьте символ '@' перед именем функции.

Синтаксис

fopen(filename, mode, include_path, context)

Параметры

  • filename : Обязательный параметр, определяющий файл.
  • mode : Обязательный параметр, определяющий тип доступа к файлу или потоку.
    Он может иметь следующие возможные значения:

    • «r»: Открывает файл только для чтения; помещает указатель в начало файла.
    • «r+»: Окрывает файл для чтения и записи; помещяет указатель в начало файла.
    • «w»: Открывает файл только для записи; помещает указатель в начало файла и обрезает файл до нулевой длинны. Если файл не существует — пробует его создать.
    • «w+»: Открывает файл для чтения и записи; помещает указатель в начало файла и обрезает файл до нулевой длинны. Если файл не существует — пробует его создать.
    • «a»: Открывает файл только для записи; помещает указатель в конец файла. Если файл не существует — пытается его создать.
    • «a+»: Открывает файл для чтения и записи; помещает указатель в конец файла. Если файл не существует — пытается его создать.
    • «x»: Создаёт и открывает только для записи. Он создает новый файл и возвращает FALSE и ошибку, если файл уже существует.
    • «x+»: Создаёт и открывает для чтения и записи. Создает новый файл и возвращает FALSE и ошибку, если файл уже существует.
    • «c»: Открывает файл только для записи. Если файл не существует, то он создается. Если же файл существует, то он не обрезается (в отличие от ‘w’), и вызов к этой функции не вызывает ошибку (также как и в случае с ‘x’).
    • «c+»: Открывает файл для чтения и записи; в остальном имеет то же поведение, что и ‘c’.
    • «e»: Установить флаг close-on-exec (закрыть при запуске) на открытый файловый дескриптор. Доступно только в PHP скомпилированном на системах поддерживающих POSIX.1-2008.
  • include_path : Необязательный параметр, для которого установлено значение в ‘1’ или TRUE, если вы хотите искать файл в include_path (например, php.ini).
  • context : Необязательный параметр, который используется для установки поведения потока.

В этом уроке мы будем использовать текстовый файл mane.txt:

AJAX = Asynchronous JavaScript and XML
CSS = Cascading Style Sheets
HTML = Hyper Text Markup Language
PHP = PHP Hypertext Preprocessor
SQL = Structured Query Language
SVG = Scalable Vector Graphics
XML = EXtensible Markup Language

В следующем примере, ипользуя функцию fopen(), откроем файл «mane.txt» в режиме чтения:

<?php
$myfile = fopen("mane.txt", "r") or die("Невозможно открыть файл!");
echo fread($myfile,filesize("mane.txt"));
fclose($myfile);
?>

Конструкция or die(«Невозможно открыть файл!») позволяет прекратить работу скрипта и вывесте некоторое сообщение об ошибке, если функция fopen не смогла открыть файл.


Чтение файла — fread()

Функция fread() считывает информацию из открытого файла.

Первый параметр fread() содержит имя файла для чтения, а второй параметр указывает максимальное количество байтов для чтения.

Следующий код PHP читает файл «mane.txt» до конца:

fread($myfile,filesize(«mane.txt»));

Закрытие файла — fclose()

Функция fclose() используется, чтобы закрыть открытый файл.

Синтаксис

bool fclose ( resource handle )

Функция закрывает файл, на который указывает handle.

Возвращает TRUE в случае успешного завершения или FALSE в случае возникновения ошибки.

Дескриптор должен указывать на файл, открытый ранее с помощью функции fopen() или fsockopen().

<?php
$myfile = fopen(«mane.txt», «r»);
// какой-то код для выполнения…
fclose($myfile);
?>

Примечание: Хорошая практика программирования — закрывать все файлы после того, как вы закончили с ними работать. Дело в том, что открытый файл на вашем сервере продолжает занимать ресурсы!

Однострочное чтение — fgets()

Функция fgets() используется для чтения одной строки из файла.

В приведенном ниже примере выводится первая строка файла mane.txt:

<?php
$myfile = fopen("mane.txt", "r") or die("Невозможно открыть файл!");
echo fgets($myfile);
fclose($myfile);
?>

Примечание: После вызова функции fgets() указатель файла переместился на следующую строку.

Проверка окончания файла — feof()

Функция feof() определяет, достигнут ли конец файла. Если в указанном дескрипторе, определяется окончание файла, возвращает True. В противном случае, False.

Функция feof() полезна для цикла работающего с данным неизвестной длины.

В приведенном ниже примере файл «mane.txt» считывается построчно, пока не будет достигнут конец файла:

<?php
$myfile = fopen("mane.txt", "r") or die("Невозможно открыть файл!");
while(!feof($myfile)) { // цикл завершится, при обнаружении конца файла
echo fgets($myfile) . "<br>"; // Вывести одну строку
}
?>

Чтение одного символа — fgetc()

Функция fgetc() используется для чтения одного символа из файла.

В приведенном ниже примере файл «mane.txt» считывается посимвольно, пока не будет достигнут конец файла:

<?php
$myfile = fopen("mane.txt", "r") or die("Невозможно открыть файл!");
while(!feof($myfile)) { // цикл завершится, при обнаружении конца файла
echo fgetc($myfile) . "<br>"; // Вывести один символ
}
?>

Примечание: Не перепутайте имя функции fgets() оканчивается символом s — string, а имя функции fgetc() оканчивается символом c — character.


PHP Экзаменатор

fopen

(PHP 4, PHP 5, PHP 7)

fopenОткрывает файл или URL

Описание

resource fopen
( string $filename
, string $mode
[, bool $use_include_path = false
[, resource $context
]] )

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

filename

Если filename передан в форме «scheme://…»,
он считается URL’ом и PHP проведёт поиск обработчика протокола
(также известного как «обертка») для этой схемы. Если ни одна
обёртка не закреплена за протоколом, PHP выдаст замечание,
чтобы помочь вам отследить потенциальную проблему в вашем
скрипте и затем продолжит выполнение, как если бы filename
указывал на обыкновенный файл.

Если PHP установлено, что filename указывает на
локальный файл, тогда выполняется попытка открыть поток к этому файлу.
Файл должен быть доступен PHP, так что вам следует убедиться,
что права доступа на файл это разрешают.
Если вы включили безопасный режим
или open_basedir, то накладываются
дальнейшие ограничения.

Если PHP установлено, что filename указывает на
зарегистрированный протокол и этот протокол зарегистрирован как
сетевой URL, PHP выполняет проверку состояния директивы
allow_url_fopen.
Если она выключена, PHP выдаст предупреждение и вызов fopen закончится
неудачей.

Замечание:

Список поддерживаемых протоколов доступен в разделе Поддерживаемые протоколы и обработчики (wrappers).
Некоторые протоколы (обертки) поддерживают
контекст и/или опции php.ini.
Обратитесь к соответствующей странице с описанием используемого протокола
для получения списка опций, которые могут быть установлены.
(например, значение php.ini user_agent используется
оберткой http).

На платформе Windows, необходимо экранировать все
обратные слеши в пути к файлу или использовать прямые слеши.


<?php
$handle 
fopen("c:\\folder\\resource.txt""r");
?>

mode

Параметр mode указывает тип доступа, который вы
запрашиваете у потока. Он может быть одним из следующих вариантов:


Список возможных режимов для fopen()
используя mode

mode Описание
‘r’ Открывает файл только для чтения; помещает указатель
в начало файла.
‘r+’ Открывает файл для чтения и записи; помещает указатель
в начало файла.
‘w’ Открывает файл только для записи; помещает указатель
в начало файла и обрезает файл до нулевой длины.
Если файл не существует — пробует его создать.
‘w+’ Открывает файл для чтения и записи; помещает указатель
в начало файла и обрезает файл до нулевой длины.
Если файл не существует — пытается его создать.
‘a’ Открывает файл только для записи; помещает указатель в конец
файла. Если файл не существует — пытается его создать.
‘a+’ Открывает файл для чтения и записи; помещает указатель в конец
файла. Если файл не существует — пытается его создать.
‘x’ Создаёт и открывает только для записи; помещает указатель в
начало файла. Если файл уже существует, вызов
fopen() закончится неудачей, вернёт FALSE и
выдаст ошибку уровня E_WARNING.
Если файл не существует, попытается его создать. Это эквивалентно
указанию флагов O_EXCL|O_CREAT для внутреннего
системного вызова open(2).
‘x+’ Создаёт и открывает для чтения и записи; иначе имеет то же поведение что и‘x’.
‘c’ Открывает файл только для записи. Если файл не существует, то он создается.
Если же файл существует, то он не обрезается (в отличии от
‘w’), и вызов к этой функции не вызывает ошибку (также как
и в случае с ‘x’). Указатель на файл будет установлен
на начало файла. Это может быть полезно при желании заблокировать
файл (смотри flock()) перед изменением, так как использование
‘w’ может обрезать файл еще до того как была получена блокировка
(если вы желаете обрезать файл, можно использовать функцию
ftruncate() после запроса на блокировку).
‘c+’ Открывает файл для чтения и записи; иначе имеет то же поведение, что и ‘c’.

Замечание:

Разные семейства операционных систем имеют разные соглашения
относительно окончания строк. Когда вы пишете текст и хотите вставить
разрыв строки, вы должны использовать правильные символы (или символ) для
вашей операционной системы. Системы семейства Unix используют
\n в качестве символа конца строки, системы
семейства Windows используют \r\n в качестве
символов окончания строки и системы семейства Macintosh используют
\r в качестве символа конца строки.

Если вы используете неверный символ конца строки при редактировании
файлов, вы можете обнаружить, что при открытии эти файлы «странно
выглядят».

Windows предлагает флаг режима текстовой трансляции
(‘t’), который автоматически переведёт
\n в \r\n во время работы с файлом.
И наоборот — вы также можете использовать ‘b’, чтобы
принудительно включить бинарный режим, в котором ваши данные
не будут преобразовываться. Чтобы использовать эти режимы, укажите
‘b’ или ‘t’ последней
буквой параметра mode.

Так как установка флага трансляции по умолчанию зависит от SAPI и используемой версии
PHP, рекомендуем явно задавать указанный флаг
из соображений портируемости. Вы должны использовать режим
‘t’, если вы работаете с текстовым файлом и
использовать \n для обозначения
конца строки в вашем скрипте, при этом не беспокоясь за читаемость
ваших файлов в других приложениях типа «Блокнота». Во всех остальных случаях
используйте флаг ‘b’.

Если вы явно не укажете флаг ‘b’ во время работы с бинарными файлами,
вы можете столкнуться со странной порчей ваших данных, включая
испорченные файлы изображений и странные проблемы с символами \r\n.

Замечание:

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

Замечание:

Кроме того, из соображений портируемости, также настойчиво
рекомендуется переписать старый код, который полагается на режим
‘t’, чтобы вместо этого он использовал правильные
концы строк и режим ‘b’.

use_include_path

Необязательный третий параметр use_include_path
может быть установлен в ‘1’ или TRUE, если вы также хотите провести
поиск файла в include_path.

context

Замечание: Поддержка контекста была добавлена
в PHP 5.0.0. Для описания контекстов смотрите раздел
Потоки.

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

Возвращает указатель на файл в случае успешной работы, или FALSE в случае ошибки.

Ошибки

Если открыть файл не удалось, будет сгенерирована ошибка уровня
E_WARNING. Вы можете использовать оператор
@ для подавления этой ошибки.

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

Версия Описание
5.2.6 Добавлены опции ‘c’ и ‘c+’
4.3.2 С версии PHP 4.3.2, по умолчанию устанавливается бинарный режим для всех платформ, различающих
бинарный и текстовый режимы. Если у вас появились проблемы после обновления,
попытайтесь использовать в качестве обхода проблемы флаг ‘t’, пока
вы не сделаете ваш скрипт более портируемым, как это было указано выше.

Примеры

Пример #1 Примеры использования fopen()


<?php
$handle 
fopen("/home/rasmus/file.txt""r");
$handle fopen("/home/rasmus/file.gif""wb");
$handle fopen("http://www.example.com/""r");
$handle fopen("ftp://user:password@example.com/somefile.txt""w");
?>

Примечания

Внимание

При использовании SSL,
Microsoft IIS нарушает протокол, закрывая соединение без отправки
индикатора close_notify. PHP сообщит об этом как «SSL: Fatal Protocol Error»
в тот момент, когда вы достигнете конца данных. Чтобы обойти это, вы должны
установить error_reporting на
уровень, исключающий E_WARNING.
PHP версий 4.3.7 и старше умеет определять, что на стороне сервера находится
проблемный IIS при открытии потока с помощью обертки https:// и не выводит предупреждение.
Если вы используете fsockopen() для создания ssl:// сокета,
вы сами отвечаете за определение и подавление этого предупреждения.

Замечание: Когда опция safe mode включена, PHP проверяет,
имеет ли каталог, с которым вы собираетесь работать, такой же UID (владельца),
как и выполняемый скрипт.

Замечание:

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

Замечание:

Эта функция также может выполниться успешно, в случае если
filename является директорией.
Если вы не уверены является ли filename файлом или директорией,
то вам необходимо воспользоваться функцией is_dir(),
до вызова fopen().

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

  • Поддерживаемые протоколы и обработчики (wrappers)
  • fclose() — Закрывает открытый дескриптор файла
  • fgets() — Читает строку из файла
  • fread() — Бинарно-безопасное чтение файла
  • fwrite() — Бинарно-безопасная запись в файл
  • fsockopen() — Открывает соединение с интернет сокетом или доменным сокетом Unix
  • file() — Читает содержимое файла и помещает его в массив
  • file_exists() — Проверяет наличие указанного файла или каталога
  • is_readable() — Определяет существование файла и доступен ли он для чтения
  • stream_set_timeout() — Устанавливает значение тайм-аута на потоке
  • popen() — Открывает файловый указатель процесса
  • stream_context_create() — Создаёт контекст потока
  • umask() — Изменяет текущую umask
  • SplFileObject

Вернуться к: Файловая система

The fopen() function in PHP is an inbuilt function which is used to open a file or an URL. It is used to bind a resource to a steam using a specific filename. The filename and mode to be checked are sent as parameters to the fopen() function and it returns a file pointer resource if a match is found and a False on failure. The error output can be hidden by adding an ‘@’ in front of the function name.

Syntax:

resource fopen ( $file, $mode, $include_path, $context)

Parameters Used:
The fopen() function in PHP accepts four parameters.

  • $file: It is a mandatory parameter which specifies the file.
  • $mode: It is a mandatory parameter which specifies the access type of the file or stream.
    It can have the following possible values:
    • “r”: It represents Read only. It starts at the beginning of the file.
    • “r+”: It represents Read/Write.It starts at the beginning of the file.
    • “w”: It represents Write only.It opens and clears the contents of file or create a new file if it doesn’t exist.
    • “w+”: It represents Read/Write. It opens and clears the contents of file or creates a new file if it doesn’t exist.
    • “a”: It represents Write only. It opens and writes to the end of the file or creates a new file if it doesn’t exist.
    • “a+”: It represents Read/Write. It preserves the file’s content by writing to the end of the file.
    • “x”: It represents Write only. It creates a new file and returns FALSE and an error if the file already exists.
    • “x+”: It represents Read/Write.It creates a new file and returns FALSE and an error if file already exists.
  • $include_path: It is an optional parameter which is set to 1 if you want to search for the file in the include_path (Ex. php.ini).
  • $context: It is an optional parameter which is used to set the behavior of the stream.

Return Value:
It returns a file pointer resource on success, or FALSE on error.

Exceptions:

  • When writing to a text file, the correct line-ending character should be used based on the platform.For example Unix systems use \n, Windows systems use \r\n, and Macintosh systems use \r as the line ending character.
  • It is recommended to use the ‘b’ flag when opening files with fopen().
  • An error of level E_WARNING is generated if the open fails.
  • When safe mode is enabled, PHP checks whether the directory in which the script is operating has the same UID (owner) as the script that is being executed.
  • If you are unsure whether filename is a file or a directory, you may need to use the is_dir() function before calling fopen() since fopen() function may also succeed when filename is a directory.

Below programs illustrate the fopen() function.

Program 1:

<?php

$myfile = fopen("/home/geeks/gfg.txt", "r"

                 or die("File does not exist!");

?>

Output:

File does not exist!

Program 2:

<?php 

$myfile = fopen("gfg.txt", 'r+'

     or die("File does not exist!");

$pointer = fgets($myfile);

echo $pointer;

fclose($myfile);

?>

Output:

portal for geeks!

Program 3:

<?php 

$myfile = fopen("gfg.txt", "rb");

$contents = fread($myfile, filesize($myfile));

fclose($myfile);

print $contents;

?>

Output:

portal for geeks!

Program 4:

<?php 

$myfile = fopen("gfg.txt", "w+");

fwrite($myfile, 'geeksforgeeks');

rewind($myfile);

fwrite($myfile, 'geeksportal');

rewind($myfile);

echo fread($myfile, filesize("gfg.txt"));

fclose($myfile);

?>

Output:

geeksportalks

Reference:
http://php.net/manual/en/function.fopen.php

Работа с файловой системой

Последнее обновление: 1.11.2015

Как и большинство языков программирования, PHP поддерживает работу с файлами, которые являются одним из способов хранения информации.

Чтение и запись файлов

Открытие и закрытие файлов

Для открытия файлов в PHP определена функция fopen(). Она имеет следующее определение:
resource fopen(string $filename, string $mode). Первый параметр $filename представляет путь к файлу, а второй — режим открытия. В зависимости
от цели открытия и типа файла данный параметр может принимать следующие значения:

  • 'r': файл открывается только для чтения. Если файла не существует, возвращает false

  • 'r+': файл открывается только для чтения с возможностью записи. Если файла не существует, возвращает false

  • 'w': файл открывается для записи. Если такой файл уже существует, то он перезаписывается, если нет — то он создается

  • 'w+': файл открывается для записи с возможностью чтения. Если такой файл уже существует, то он перезаписывается, если нет — то он создается

  • 'a': файл открывается для записи. Если такой файл уже существует, то данные записываются в конец файла, а старые данные остаются.
    Если файл не существует, то он создается

  • 'a+': файл открывается для чтения и записи. Если файл уже существует, то данные дозаписываются в конец файла. Если файла нет, то он создается

Результатом функции fopen будет дескриптор файла. Этот дескриптор используется для операций с файлом и для его закрытия.

После окончания работы файл надо закрыть с помощью функции fclose(), которая принимает в качестве параметра дескриптор файла. Например,
откроем и закроем файл:

$fd = fopen("form.php", 'r') or die("не удалось открыть файл");
fclose($fd);

Конструкция or die("текст ошибки") позволяет прекратить работу скрипта и вывесте некоторое сообщение об ошибке, если функция fopen
не смогла открыть файл.

Чтение файла

Для чтения файла можно использовать несколько функций. Для построчного чтения используется функция fgets(),
которая получает дескриптор файла и возвращает одну считанную строку. Пройдем построчно по всему файлу:

<?php
$fd = fopen("form.php", 'r') or die("не удалось открыть файл");
while(!feof($fd))
{
	$str = htmlentities(fgets($fd));
	echo $str;
}
fclose($fd);
?>

При каждом вызове fgets() PHP будет помещать указатель в конец считанной строки. Чтобы проследить окончание файла, используется функция
feof(), которая возвращает true при завершении файла. И пока не будет достигнут конец файла, мы можем применять функцию
fgets().

Чтение файла полностью

Если нам надо прочитать файл полностью, то мы можем облегчить себе жизнь, применив функцию file_get_contents():

<?php
$str = htmlentities(file_get_contents("form.php"));
echo $str;
?>

При этом нам не надо открывать явно файл, получать дескриптор, а затем закрывать файл.

Поблочное считывание

Также можно провести поблочное считывание, то есть считывать определенное количество байт из файла с помощью функции fread():

<?php
$fd = fopen("form.php", 'r') or die("не удалось открыть файл");
while(!feof($fd))
{
	$str = htmlentities(fread($fd, 600));
	echo $str;
}
fclose($fd);
?>

Функция fread() принимает два параметра: дескриптор считываемого файла и количество считываемых байтов. При считывании блока указатель в файле
становится в конец этого блока. И также с помощью функции feof() можно отследить завершение файла.

Запись файла

Для записи файла применяется функция fwrite(), которая записывает в файл строку:

<?php
$fd = fopen("hello.txt", 'w') or die("не удалось создать файл");
$str = "Привет мир";
fwrite($fd, $str);
fclose($fd);
?>

Аналогично работает другая функция fputs():

<?php
$fd = fopen("hello.txt", 'w') or die("не удалось создать файл");
$str = "Привет мир";
fputs($fd, $str);
fclose($fd);
?>

Работа с указателем файла

При открытии файла для чтения или записи в режиме ‘w’, указатель в файле помещается в начало. При считывании данных PHP перемещает указатель в файле в конец блока
считанных данных. Однако мы также вручную можем управлять указателем в файле и устанавливать его в произвольное место. Для этого надо использовать функцию
fseek, которая имеет следующее формальное определение:

int fseek (resource $handle , int $offset [, int $whence = SEEK_SET ] )

Параметр $handle представляет дескриптор файла. Параметр $offset — смещение в байтах относительно начала файла, с которого начнется считывание/запись.
Третий необязательный параметр задает способ установки смещения. Он может принимать три значения:

  • SEEK_SET: значение по умолчанию, устанавливает смещение в offset байт относительно начала файла

  • SEEK_CUR: устанавливает смещение в offset байт относительно начала текущей позиции в файле

  • SEEK_END: устанавливает смещение в offset байт от конца файла

В случае удачной установки указателя функция fseek() возвращает 0, а при неудачной установке возвращает -1.

Пример использования функции:

$fd = fopen("hello.txt", 'w+') or die("не удалось открыть файл");
$str = "Привет мир!"; // строка для записи
fwrite($fd, $str); // запишем строку в начало
fseek($fd, 0); // поместим указатель файла в начало
fwrite($fd, "Хрю"); // запишем в начало строку
fseek($fd, 0, SEEK_END); // поместим указатель в конец
fwrite($fd, $str); // запишем в конце еще одну строку
fclose($fd);

Понравилась статья? Поделить с друзьями:
  • Возвратиться назад лексическая ошибка
  • Возвратившись домой мне не спалось ошибка
  • Воз признала пандемию ошибкой
  • Возврат товара при ошибке продавца
  • Воз врачебные ошибки