file_put_contents
on file() and flock()
My supervisor came up with a brilliant plan to workaround the inability of the file() to work on a flock()'ed file.
We created a dummy file called lockfile.txt. We would flock() lockfile.txt. Once we had a lock on it, we used file() on the file we wanted to read, then altered the file and called fclose on both files.
file
(PHP 4, PHP 5)
file — Lê todo o arquivo para um array
Descrição
array file
( string $filename
[, int $flags
[, resource $context
]] )
Carrega todo um arquivo em um array.
Nota: Você pode utilizar file_get_contents() para ler o conteúdo de um arquivo como string.
Parâmetros
- filename
-
Caminho até o arquivo
DicaVocê pode usar uma URL como um nome de arquivo nesta função se fopen wrappers estiver habilitado. Veja fopen() para mais detalhes em como especificar o nome do arquivo e List of Supported Protocols/Wrappers para uma lista de protocolos URL suportados.
- flags
-
O parâmetro opcional flags pode ser uma ou mais das seguintes constantes:
- FILE_USE_INCLUDE_PATH
- Procurar pelo arquivo no include_path.
- FILE_IGNORE_NEW_LINES
- Não acrescentar a quebra de linha no final de cada elemento do array
- FILE_SKIP_EMPTY_LINES
- Ignorar linhas vazias
- FILE_TEXT
- O arquivo é retornado na codificação UTF-8. Você pode especificar uma codificação diferente criando um contexto personalizado. Esta constante não pode ser utilizada com FILE_BINARY. Esta flag está disponível apenas a partir do PHP 6.
- FILE_BINARY
- O conteúdo é lido como binário. Esta é a opção padrão e não pode ser utilizada com FILE_TEXT. Esta flag está disponível apenas a partir do PHP 6.
- context
-
Um recurso de contexto criado com a função stream_context_create().
Nota: O suporte ao contexto foi adicionado com o PHP 5.0.0. Para uma descrição de contextos, veja Stream Funções
Valor Retornado
Retorna o arquivo em um array. Cada elemento do array corresponde a uma linha no arquivo, ainda com a quebra de linha. Em caso de falha, file() retorna FALSE
Nota: Cada linha no array incluirá a quebra de linha, a não ser que FILE_IGNORE_NEW_LINES seja usado, então você ainda deve usar rtrim() se não desejar ter as quebras de linha presentes.
Nota: Se PHP não está apropriadamente reconhecendo o final de linha quando lendo arquivos ou criando por um computador Macintosh, habilitando a opção auto_detect_line_endings em tempo de execução pode ajudar a resolver o problema.
Histórico
| Versão | Descrição |
|---|---|
| 6.0.0 | Adicionado suporte às flags FILE_TEXT e FILE_BINARY. |
| 5.0.0 | O parâmetro context foi adicionado |
| 5.0.0 | Até o PHP 5.0.0, o parâmetro flags suportava apenas include_path e era habilitado com 1 |
| 4.3.0 | file() tornou-se segura para binários |
Exemplos
Exemplo #1 Exemplo de file()
<?php
// Lê um arquivo em um array. Nesse exemplo nós obteremos o código fonte de
// uma URL via HTTP
$lines = file ('http://www.example.com/');
// Percorre o array, mostrando o fonte HTML com numeração de linhas.
foreach ($lines as $line_num => $line) {
echo "Linha #<b>{$line_num}</b> : " . htmlspecialchars($line) . "<br>\n";
}
// Outro exemplo, onde obtemos a página web inteira como uma string. Veja também file_get_contents().
$html = implode ('', file ('http://www.example.com/'));
// Usando o parâmetro de flags opcionais disponíveis desde o PHP 5
$trimmed = file('somefile.txt', FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
?>
Notas
Aviso
Quando usando SSL, o Microsoft IIS irá violar o protocolo fechando a conexão sem enviar uma notificação close_notify. O PHP acusará isso como sendo "SSL: Fatal Protocol Error" quando tentar ler os dados. Para prevenir isso, o valor de error_reporting deve ser reduzido para um nível que não inclui avisos. para o nível que não emita warnings. O PHP 4.3.7 e seguintes conseguem detectar servidores IIS defeituosos quando você abre um stream utilizando o wrapper https:// e suprimirá os avisos. Se você está usando fsockopen() para criar um socket ssl://, a responsabilidade de detectar e suprimir esse aviso passa para você.
Veja Também
- readfile() - Lê e exibe o conteúdo de um arquivo
- fopen() - Abre um arquivo ou URL
- fsockopen() - Abre um socket de conexão Internet ou de domínio Unix
- popen() - Abre um processo como ponteiro de arquivo
- file_get_contents() - Lê todo o conteúdo de um arquivo para uma string
- include() - include
- stream_context_create() - Create a streams context
add a note
User Contributed Notesfile
PenguinMan98 at usa dot net
21-Apr-2008 10:49
21-Apr-2008 10:49
jon+spamcheck at phpsitesolutions dot com
16-Apr-2008 08:03
16-Apr-2008 08:03
A user suggested using rtrim always, due to the line ending conflict with files that have an EOL that differs from the server EOL.
Using rtrim with it's default character replacement is a bad solution though, as it removes all whitespace in addition to the '\r' and '\n' characters.
A good solution using rtrim follows:
<?php
$line = rtrim($line, "\r\n") . PHP_EOL;
?>
This removes only EOL characters, and replaces with the server's EOL character, thus making preg_* work fine when matching the EOL ($)
bubbles
05-Apr-2008 10:45
05-Apr-2008 10:45
althought it's mentioned twice in the description, it took me a whole night to figure out why i got new-lines in my array.
hence you have to put a flag on it FILE_IGNORE_NEW_LINES.
I mention, just you wouldn't miss this little anoying thing.
*you can use trim, but it's slighty different.
vbchris at gmail dot com
16-Feb-2008 09:15
16-Feb-2008 09:15
If you're getting "failed to open stream: Permission denied" when trying to use either file() or fopen() to access files on another server. Check your host doesn't have any firewall restrictions in-place which prevent outbound connections. This is the case with my host Aplus.net
Reversed: moc dot liamg at senroc dot werdna
12-Jul-2007 09:25
12-Jul-2007 09:25
This note applies to PHP 5.1.6 under Windows (although may apply to other versions).
It appears that the 'FILE_IGNORE_NEW_LINES' flag doesn't remove newlines properly when reading Windows-style text files, i.e. files whose lines end in '\r\n'.
Solution: Always use 'rtrim()' in preference to 'FILE_IGNORE_NEW_LINES'.
info at carstanje dot com
28-Nov-2006 08:33
28-Nov-2006 08:33
Using file() for reading large text files > 10 Mb gives problems, therefore you should use this instead. It is much slower but it works fine. $lines will return an array with all the lines.
<?php
$handle = @fopen('yourfile...', "r");
if ($handle) {
while (!feof($handle)) {
$lines[] = fgets($handle, 4096);
}
fclose($handle);
}
?>
richardtcunningham at gmail dot com
11-Jul-2006 09:19
11-Jul-2006 09:19
justin at visunet dot ie's note of 20-Mar-2003 states
"Note: Now that file() is binary safe it is 'much' slower than it used to be. If you are planning to read large files it may be worth your while using fgets() instead of file()."
I tested fgets(), file_get_contents(), and file() on PHP 4.3.2 and PHP 5 and timed each to be under a second with over 200,000 lines. I do not know if he was testing extremely long lines or what, but I could not duplicate the difference that he mentioned.
jonathan dot gotti at free dot fr
01-Feb-2006 10:52
01-Feb-2006 10:52
you can use
$file = array_map('rtrim',file('myfile.txt'));
to remove annoying ending lines of the resulting array.
Nuts
18-Jan-2006 11:16
18-Jan-2006 11:16
WARNING ON WINDOWS:
file() function will add "\r\n" in to the end of the row, even if you use only "\n" char to make rows in the file!
On UNIX systems there is no such problem.
dir @ badblue com
12-Sep-2003 09:48
12-Sep-2003 09:48
Jeff's array2file function is a good start; here are a couple of improvements (no possibility of handle leak when fwrite fails, additional capability of both string2file and array2file; presumably faster performance through use of implode).
<?php
function String2File($sIn, $sFileOut) {
$rc = false;
do {
if (!($f = fopen($sFileOut, "wa+"))) {
$rc = 1; break;
}
if (!fwrite($f, $sIn)) {
$rc = 2; break;
}
$rc = true;
} while (0);
if ($f) {
fclose($f);
}
return ($rc);
}
function Array2File($aIn, $sFileOut) {
return (String2File(implode("\n", $aIn), $sFileOut));
}
?>
If you're generating your string text using a GET or POST from a TEXTAREA (e.g., a mini-web-text-editor), remember that strip_slashes and str_replace of "/r/n" to "/n" may be necessary as well using these functions.
HTH --dir @ badblue com
John
20-Jul-2003 11:32
20-Jul-2003 11:32
after many months of confusion and frustration, i have finally figured out something that i should have noticed the first time around.
you can't file("test.txt") when that same file has been flocked. i guess i didn't have a full understanding of what i was doing when i used flock(). all i had to do was move the flock() around, and all was well.
justin at visunet dot ie
20-Mar-2003 05:36
20-Mar-2003 05:36
Note: Now that file() is binary safe it is 'much' slower than it used to be. If you are planning to read large files it may be worth your while using fgets() instead of file() For example:
<?php
$fd = fopen ("log_file.txt", "r");
while (!feof ($fd))
{
$buffer = fgets($fd, 4096);
$lines[] = $buffer;
}
fclose ($fd);
?>
The resulting array is $lines.
I did a test on a 200,000 line file. It took seconds with fgets() compared to minutes with file().
andrea at brancatelli dot it
16-Mar-2002 07:16
16-Mar-2002 07:16
file() has a strange behaviour when reading file with both \n and \r as line delimitator (DOS files), since it will return an array with every single line but with just a \n in the end. It seems like \r just disappears.
This is happening with PHP 4.0.4 for OS/2. Don't know about the Windows version.
php@don't_spam_me
09-Feb-2002 08:56
09-Feb-2002 08:56
It appears that the file() function causes file access problems for perl cgi scripts accessing the same files. I am using Perl v5.6.0 in linux with PHP/4.0.4pl1. After running a php app using the file() function, any perl cgi trying to access the same file randomly dies returning an internal server error: premature end of script headers.
The simple fix is to use fopen(), fgets() and fclose() instead of file().