PHP 5.6.0 released

file

(PHP 4, PHP 5)

fileLegge l'intero file in un vettore

Descrizione

array file ( string $filename [, int $use_include_path [, resource $context ]] )

Identica a readfile(), eccetto per il fatto che file() restituisce il file in un vettore. Ogni elemento del vettore corrisponde ad una riga del file, con il carattere di newline ancora inserito. Se la funzione non riesce restituisce FALSE.

Puoi impostare il secondo parametro, use_include_path, (opzionale) ad "1", se vuoi cercare il file nel include_path.

<?php
// inserisce una pagina web in un array e la stampa. In questo esempio useremo il protocollo
// HTTP per ottenere il sorgente di un URL
$lines file('http://www.example.com/');
// Ciclo attraverso l'array, si visualizzerà il sorgente come html ed i numeri di linea
foreach($lines as $line_num => $line) {
    echo 
"Line #<b>{$line_num}</b> : " htmlspecialchars($line) . "<br />\n";
}

// Un'altro esempio, inserisce la pagina web in una stringa. Vedere anche  file_get_contents().
$html implode(''file ('http://www.example.com/'));
?>

Suggerimento

È possibile utilizzare una URL come un nome di file con questa funzione se fopen wrappers è stata abilitata. Vedere fopen() per maggiori informazioni su come specificare i nomi di file. Vedere Supported Protocols and Wrappers per i link verso le informazioni sulle capacità dei vari wrapper, note sul loro uso, informazioni sulle variabili predefinite che forniscono.

Nota:

Ciascuna riga dell'array restituito conterrà il carattere di fine riga, occorre, pertanto, utilizzare rtrim() se si desidera rimuovere il carattere di fine riga.

Nota: Se si hanno problemi con il PHP che non riconosce i fine linea leggendo file creati o ospitati su un computer Macintosh, si può abilitare l'opzione auto_detect_line_endings della configurazione di runtime.

Nota:

A partire da PHP 4.3.0 si può utilizzare file_get_contents() per memorizzare il contenuto di un file in una stringa in formato binario.

Nota: Il supporto per il contesto è stato aggiunto in PHP 5.0.0. Per la descrizione del contesto, fare riferimento a Stream Funzioni.

Avviso

Quando si usa SSL, Microsoft IIS viola il protocollo chiudendo la connessione senza inviare un'indicazione close_notify. PHP indicherà questo con un "SSL: Fatal Protocol Error" al raggiungimento della fine dei dati. Per aggirare questo problema, occorre abbassare il livello error_reporting per non includere questi avvisi. PHP 4.3.7 e successivi sono in grado di identificare gli IIS bacati quando si apre lo stream utilizzando il wrapper https:// e disabilitano automaticamente l'avviso. Se si usa fsockopen() per creare un socket ssl://, occorre identificare e sopprimere l'avviso manualmente.

Vedere anche readfile(), fopen(), fsockopen(), popen(), file_get_contents() e include.

add a note add a note

User Contributed Notes 12 notes

up
13
twichi at web dot de
2 years ago
read from CSV data (file) into an array with named keys

... with or without 1st row = header (keys)
(see 4th parameter of function call as  true / false)

<?php
// --------------------------------------------------------------

function csv_in_array($url,$delm=";",$encl="\"",$head=false) {
   
   
$csvxrow = file($url);   // ---- csv rows to array ----
   
   
$csvxrow[0] = chop($csvxrow[0]);
   
$csvxrow[0] = str_replace($encl,'',$csvxrow[0]);
   
$keydata = explode($delm,$csvxrow[0]);
   
$keynumb = count($keydata);
   
    if (
$head === true) {
   
$anzdata = count($csvxrow);
   
$z=0;
    for(
$x=1; $x<$anzdata; $x++) {
       
$csvxrow[$x] = chop($csvxrow[$x]);
       
$csvxrow[$x] = str_replace($encl,'',$csvxrow[$x]);
       
$csv_data[$x] = explode($delm,$csvxrow[$x]);
       
$i=0;
        foreach(
$keydata as $key) {
           
$out[$z][$key] = $csv_data[$x][$i];
           
$i++;
            }   
       
$z++;
        }
    }
    else {
       
$i=0;
        foreach(
$csvxrow as $item) {
           
$item = chop($item);
           
$item = str_replace($encl,'',$item);
           
$csv_data = explode($delm,$item);
            for (
$y=0; $y<$keynumb; $y++) {
              
$out[$i][$y] = $csv_data[$y];
            }
       
$i++;
        }
    }

return
$out;
}

// --------------------------------------------------------------

?>

fuction call with 4 parameters:

(1) = the file with CSV data (url / string)
(2) = colum delimiter (e.g: ; or | or , ...)
(3) = values enclosed by (e.g: ' or " or ^ or ...)
(4) = with or without 1st row = head (true/false)

<?php

// ----- call ------
$csvdata = csv_in_array( $yourcsvfile, ";", "\"", true );
// -----------------

// ----- view ------
echo "<pre>\r\n";
print_r($csvdata);
echo
"</pre>\r\n";
// -----------------

?>

PS: also see: http://php.net/manual/de/function.fgetcsv.php to read CSV data into an array
... and other file-handling methods

^
up
7
bingo at dingo dot com
10 months ago
To write all the lines of the file in other words to read the file line by line you can write the code like this:
<?php
$names
=file('name.txt');
// To check the number of lines
echo count($names).'<br>';
foreach(
$names as $name)
{
   echo
$name.'<br>';
}
?>

this example is so basic to understand how it's working. I hope it will help many beginners.

Regards,
Bingo
up
3
d basin
4 years ago
this may be obvious, but it took me a while to figure out what I was doing wrong. So I wanted to share. I have a file on my "c:\" drive. How do I file() it?

Don't forget the backslash is special and you have to "escape" the backslash i.e. "\\":

<?php

$lines
= file("C:\\Documents and Settings\\myfile.txt");

foreach(
$lines as $line)
{
    echo(
$line);
}

?>

hope this helps...
up
1
Anonymous
8 months ago
("file()'s problem with UTF-16" is wrong. This is updated.
The former may miss the last line of the string.)

file() seems to have a problem in handling
UTF-16 with or without BOM.

file() is likely to think "\n"=LF (0A) as a line-ending.
So, not only "000A" but also "010A, 020A,...,FE0A, FF0A,..."
are regarded as line-endings.

Moreover, file() causes a serious problem in UTF-16LE.
file() loses first "0A" (the first half of "0A00")!
And the next line begins with "00" (the rest of "0A00").
So lines after the first "0A" are totally different.

To avoid this phenomena,
eg. in case (php_script : UTF-8 , file : UTF-16 with line-ending "\r\n"),

<?php

mb_regex_encoding
('UTF-16');    // to help mb_ereg_..() work properly
$str = file_get_contents($file_path);
$to_encoding = 'UTF-16';        // encoding of string
$from_encoding = 'UTF-8';        // encoding of PHP_script
$pattern1 = mb_convert_encoding('[^\r]*\r\n', $to_encoding, $from_encoding);
mb_ereg_search_init($str, $pattern1);
while (
$res = mb_ereg_search_regs()) {
   
$file[] = $res[0];
}
$pattern2 = mb_convert_encoding('\A.*\r\n(.*)\z', $to_encoding, $from_encoding);
mb_ereg($pattern2, $str, $match);
   
$file[] = $match[1];

?>

instead of
$file = file($file_path);

If line-ending is "\n",
$pattern1 = mb_convert_encoding('[^\n]*\n', $to_encoding, $from_encoding);
up
0
Martin K.
24 days ago
If the file you are reading is in CSV format do not use file(), use fgetcsv().  file() will split the file by each newline that it finds, even newlines that appear within a field (i.e. within quotations).
up
-2
marco dot remy at aol dot com
2 months ago
Here's my CSV converter
supports Header and trims all fields
Note: Headers must be not empty!

<?php

function csv2array($file, $delim = ';', $encl = '"', $header = false) {
   
   
# File does not exist
   
if(!file_exists($file))
        return
false;
   
   
# Read lines of file to array
   
$file_lines = file($file, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
   
   
# Empty file
   
if($file_lines === array())
        return
NULL;
   
   
# Read headers if you want to
   
if($header === true) {
       
$line_header = array_shift($file_lines);
       
$array_header = array_map('trim', str_getcsv($line_header, $delim, $encl));
    }

   
$out = NULL;

   
# Now line per line (strings)
   
foreach ($file_lines as $line) {
       
# Skip empty lines
       
if(trim($line) === '')
            continue;
       
       
# Convert line to array
       
$array_fields = array_map('trim', str_getcsv($line, $delim, $encl));
       
       
# If header present, combine header and fields as key => value
       
if($header === true)
           
$out[] = array_combine ($array_header, $array_fields);
        else
           
$out[] = $array_fields;
    }
   
    return
$out;
}
?>
up
-1
Reversed: moc dot liamg at senroc dot werdna
7 years ago
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'.
up
-2
jon+spamcheck at phpsitesolutions dot com
6 years ago
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 ($)
up
-3
info at carstanje dot com
7 years ago
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);
}
?>
up
-4
vbchris at gmail dot com
6 years ago
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
up
-7
justin at visunet dot ie
11 years ago
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().
up
-7
andrea at brancatelli dot it
12 years ago
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.
To Top