fileatime

Last updated: Fri, 11 Apr 2008

file

(PHP 4, PHP 5)

file — Lee un archivo entero hacia una matriz

Descripción

array file ( string $nombre_archivo [, int $banderas [, resource $contexto ]] )

Lee un archivo completo a una matriz.

Note: Es posible usar file_get_contents() para devolver el contenido de un archivo como una cadena.

Lista de parámetros

nombre_archivo

Ruta al archivo.

Tip

Puede usar una URL como nombre de archivo con esta función si los fopen wrappers han sido activados. Consulte fopen() para más detalles sobre cómo especificar el nombre de fichero y Lista de Protocolos/Envolturas Soportadas una lista de protocolos URL soportados

banderas

El parámetro opcional banderas puede ser una o más de las siguientes constantes:

FILE_USE_INCLUDE_PATH: Busca por el archivo en la ruta definida en include_path.
FILE_IGNORE_NEW_LINES: No agrega una nueva línea al final de cada elemento de la matriz
FILE_SKIP_EMPTY_LINES: Salta líneas vacías
FILE_TEXT: El contenido es devuelto en la codificación UTF-8. Es posible especificar una codificación diferente creando un contexto predeterminado. Esta bandera no puede ser usada junto con FILE_BINARY. Esta bandera está disponible únicamente desde PHP 6.
FILE_BINARY: El contenido es leído como datos binarios. Este es el comportamiento predeterminado y esta bandera no puede ser usada junto con FILE_TEXT. Esta bandera está disponible únicamente desde PHP 6.

contexto

Un recurso de contexto creado con la función stream_context_create().

Note: Soporte de contexto fue introducido con PHP.5.0.0.

Valores retornados

Devuelve el archivo en una matriz. Cada elemento de la matriz corresponde a una línea en el archivo, con el salto de línea aun incluido. Si ocurre un fallo, file() devuelve FALSE.

Note: Cada línea en la matriz resultante incluye el final de línea, a menos que se use FILE_IGNORE_NEW_LINES, así que aun necesita usar rtrim() si no quiere conservar el final de línea.

Note: Si sufre problemas con PHP no reconociendo los finales de línea cuando lee archivos creados en un Macintosh (o leyendo archivos sobre uno), puede probar activando la opción de configuración auto_detect_line_endings.

Registro de cambios

Versión	Descripción
6.0.0	Se agregó el soporte para las banderas `FILE_TEXT` y `FILE_BINARY`.
5.0.0	Se agregó el parámetro `contexto`
5.0.0	Antes de PHP 5.0.0 el parámetro `banderas` solo cubría include_path y éste parámetro era habilitado con 1.
4.3.0	file() se hizo segura con material binario

Ejemplos

Example #1 Ejemplo de file()


<?php
// Obtiene un archivo en una matriz. En este ejemplo usaremos HTTP
// para obtener el código fuente HTML de una URL.

$lineas = file('http://www.example.com/');

// Recorrer nuestra matriz, mostrar el código HTML como código fuente
// HTML, y los números de línea también.
foreach ($lineas as $linea_num => $linea) {
    echo "Línea #<b>{$linea_num}</b> : " . htmlspecialchars($linea) . "<br />\n";
}

// Otro ejemplo, obtengamos una página web como una cadena. Vea
// también file_get_contents().
$html = implode('', file('http://www.example.com/'));
?>

Notes

Warning

Cuando se usa SSL, Microsoft IIS violara el protocolo, cerrando la conexion sin mandar un indicador close_notify. PHP avisara de esto con este mensaje "SSL: Fatal Protocol Error", cuando llegue al final de los datos. Una solucion a este problema es bajar el nivel de aviso de errores del sistema para que no incluya advertencias. PHP 4.3.7 y versiones posteriores detectan servidores IIS con este problema y suprime la advertencia. Si usais la funcion fsockopen() para crear un socket ssl://, tendreis que suprimir la advertencia explicitamente.

Ver también

fileatime

file_put_contents

Last updated: Fri, 11 Apr 2008

add a note User Contributed Notes
file

PenguinMan98 at usa dot net
22-Apr-2008 12:49


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.

jon+spamcheck at phpsitesolutions dot com
16-Apr-2008 10: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 12: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 10: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 11: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 09: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.



$handle = @fopen('yourfile...', "r");

if ($handle) {

   while (!feof($handle)) {

       $lines[] = fgets($handle, 4096);

   }

   fclose($handle);

}

richardtcunningham at gmail dot com
11-Jul-2006 11: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 11:52


you can use 

$file = array_map('rtrim',file('myfile.txt'));

to remove annoying ending lines of the resulting array.

Nuts
19-Jan-2006 12: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 11: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).



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
21-Jul-2003 01: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 06: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:



$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().

03-Mar-2003 11:16


You can use file with https if you go to:



http://ftp.proventum.net/pub/php/win32/misc/openssl/. 



This is instead of using the php_openssl.dll, so be sure to comment this extension in your php.ini.

andrea at brancatelli dot it
16-Mar-2002 08: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 09: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().

add a note

fileatime

file_put_contents

Last updated: Fri, 11 Apr 2008