PHP: file - Manual

Opis

array file ( string nazwa_pliku [, int użyj_include_path [, resource kontekst]] )

Działa identycznie jak readfile(), tylko że file() zwraca plik w tablicy. Każdy element tablicy odpowiada linii w pliku. Elementy tablicy zawierają znak nowej linii. W przypadku błędu, file() zwraca FALSE.

Możesz użyć opcjonalnego parametru use_include_path i ustawić go na "1", jeśli chcesz szukać pliku także w include_path.


<?php

// Pobierz plik do tablicy.  W tym przykładzie poprzez HTTP pobierzemy

// źródło HTML z URL

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

// Za pomocą pętli przeglądamy naszą tablicę i pokazujemy źródło strony w postaci

// źródła HTML oraz numery linii.

  foreach ($lines as $line_num => $line) {  

      echo "Linia #<b>{$line_num}</b> : " . htmlspecialchars($line) . "<br />\n";  

}



// Kolejny przyklad pozwala pobrać stronę i umieścić ją w łańcuchu znaków  Zobacz także file_get_contents(). 

$html = implode ('', file ('http://www.example.com/'));

?>

Podpowiedź: Jeśli włączona jest dyrektywa konfiguracyjna fopen wrappers, możliwe jest podanie jako nazwy pliku adresu URL. Zobacz opis funkcji fopen() aby dowiedzieć się jak przekazać nazwę pliku, oraz fopen wrappers aby uzyskać listę obsługiwanych protokołów.

Notatka: Każda linia w wynikowej tabeli będzie zawierać znak(i) końca linii, jeśli nie chcesz ich musisz uzyć rtrim().

Notatka: W przypadku problemów z rozpoznawaniem znaków końca linii przez PHP przy czytaniu plików stworzonych lub znajdujących się na komputerach Macintosh, może pomóc włączenie dyrektywy konfiguracji auto_detect_line_endings.

Notatka: W PHP 4.3.0 możesz użyć file_get_contents() aby zwrócić zawartość pliku do łańcucha.
W PHP 4.3.0 file() stał się binarnie bezpieczny.

Notatka: Wsparcie dla kontekstów zostało dodane w PHP 5.0.0.

Ostrzeżenie

Łącząc się przez SSL, serwer Microsoft IIS pogwałca reguły protokołu przez zamknięcie połączenia bez wysłania znacznika close_notify. PHP zgłosi to jako "SSL: Fatal Protocol Error" po przesłaniu całości danych. Aby obejść ten błąd, wystarczy obniżyć poziom raportowania błędów (error_reporting) aby nie były wyświetlane ostrzeżenia. PHP w wersji 4.3.7 i nowsze wykrywa obecność zepsutego serwera IIS przy otwieraniu strumienia przez wrapper https:// i wyłącza wyświetlanie tych ostrzeżeń. Używając funkcji fsockopen() do otwarcia gniazda ssl:// należy samemu zatroszczyć się o wyłączenie ostrzeżeń.

Patrz także: readfile(), fopen(), fsockopen(), popen(), file_get_contents() i include().

User Contributed Notes


I've creates this function to  have my own hitcounter on my site; the function writes to a file and returns the value.



Created by Mr.B



<?php

function hitcount()

{

$file = "counter.txt";

if ( !file_exists($file)){

       touch ($file);

       $handle = fopen ($file, 'r+'); // Let's open for read and write

       $count = 0;



}

else{

       $handle = fopen ($file, 'r+'); // Let's open for read and write

       $count = fread ($handle, filesize ($file));

       settype ($count,"integer");

}

rewind ($handle); // Go back to the beginning

/*

 * Note that we don't have problems with 9 being fewer characters than

  * 10 because we are always incrementing, so we will always write at

   * least as many characters as we read

   **/

fwrite ($handle, ++$count); // Don't forget to increment the counter

fclose ($handle); // Done 



return $count;

}   

?>


I used the config file reader written by mvanbeek at supporting-role dot co dot uk for one of my own scripts. I have made some modifications, and turned it into a class. 



<?



class config_reader {

  var $filename;

  var $databaseHost;

  var $databaseName;

  var $databaseUser;

  var $databasePassword;



  function config_reader () {

    $this->filename = './settings.conf';

    $this->getSettings();

  }

  

  function getSettings () {

    $config = file($this->filename);

    reset($config);

    foreach ($config as $line) {

      $line = rtrim($line);  # Get rid of newline characters

      $line = ltrim($line);  # Get rid of any leading spaces

      if ($line == "" || $line == "\n" || strstr($line,"#") == 1) {

        next($config); 

      } else {  

        list($key, $value) = preg_split("/\s*=\s*/", $line, 2); # split by "=" and removing blank space either side of it.

        $this->$key = $value;

      }

    }

  }

}



?>



Changes: 

 - I have cleaned up the layout of the code for readability and faster execution. 

 - I have moved the rtrim and ltrim functions to execute before the line check, to make sure the line wasn't just a space, or a comment after a space. 

 - I changed strstr($line, "#") to strstr($line, "#") == 1 to make sure that lines with a comment after the values are not left behind. 

 - I also changed the way preg_split assigns the results, primarily to clean up the code. 

 - I changed the way values are assigned to the variables. For me, this works better because I only needed to get the database information from the user. If you would like a dynamic listing of variables, do the following:



Remove the following lines:

<?

var $databaseHost;

var $databaseName;

var $databaseUser;

var $databasePassword;

?>



Add this line: (commented lines are only to provide location for new line)

<?

#class config_reader {

  #var $filename;

    var $settings; #ADD THIS LINE

?>



Then change this line: 

<?

$this->$key = $value;

?> 



to this: 

<?

$this->settings[$key] = $value;

?>



NOTE: This has not actually been executed, so their might be a small error. I don't recommend use of this script by those new to PHP, as you will need an understanding of file permissions and setting the variables in classes.


This code will help you if you want to pass the URL to the script by GET and the URL includes "&", so the address bar  looks like "http://www.example.com/script.php

?url=http://www.example.com/script2.php

?var1=value1&var2=value2&var3=value3"

and the effect of

echo $_GET['url'];

is

"url=http://www.example.com/script2.php?var1=value1"

because everything after the "&" is stored in other variables, so the $_GET array contains the foollowing key/value pairs:



$_GET

(

[url] => url=http://www.example.com/script2.php?var1=value1

[var2] => value2

[var3] => value3

)



This will give the file() function the proper url:



<?php

$url = $_GET['url'];

$array = array();

$count = 1; //removes the $url from $array, also a counter for custom variables

//if you want to pass multiple variables to the script, they must be before $url in $_GET

if (array_key_exists('customvar1', $_GET))

{

$count += 1; //increases the counter

}

while (list($key, $val) = each($_GET)) {

if ($count) //if ($count <> 0), else stops decreasing the counter and starts defining $array

{

$count -= 1;

} else {

$array[] = $key . "=" . $val;

}

}

$urlending = "&" . implode("&", $array); //the proper ending of the address

$url .= $urlending;

?>

the counter may be removed, but $array will also contain $url, so be careful and use only:

$url = implode("&", $array);



If you can't use the following code for any reason, pass to the script the address with additional "anything=" after every "&" and then use

$url .= implode ('&', $_GET);

NOTE:

The 'anythings' must be different after each '&'.



Hope thet helps someone


This function allows to read configuration files like this:



[level_0]

      total=>8

      [level_1]

          1=3

      [/level_1]

      [level_1]

          [level_2]

              1=something

          [/level_2]

      [/level_1]

[/level_0]



where 'level_n' may be replaced by any label to create a tree structure. This is usefull to fill an array with all the values you need in one script.



$archivo="configuration.txt";

$resultado=file($archivo);

reset($resultado);

$n=0;

foreach ($resultado as $linea) {

if (ereg("^\[\/.*\]$", rtrim($linea))) {  //close labels

$n=$n-1;  

} 

elseif (ereg("^\[.*\]$", trim($linea), $nombre)) {  //open labels

$n+=1;

$nivel[$n]=ereg_replace("(\[|\])", "", $nombre[0]);

}

elseif (($linea!="") and ($linea!="\n") and !ereg("(\/\*|\*\/)", $linea)) { //ignore empty lines and comments in '/* */' format

$pares=explode("=", trim($linea));  //separate key and value

for($i=$n; $i>0; $i--) { //fill the array

if ($i==$n) {${$nivel[$i]}[$pares[0]]=$pares[1]; }

else {${$nivel[$i]}[$nivel[$i+1]]=${$nivel[$i+1]}; }

}

$propiedades[$nivel[1]]=${$nivel[1]};

}

}


Beware of using file() to call a URL from a remote server on a live Web site, as there is no way to set a maximum connection time.



To exemplify this I cite the circumstance of a Web site which receives content from a remote server in the form of an XML feed. If the remote server does not respond, the Web page will hang and if this is a regular occurance, the parts of the Web site which use the feed may often prove inaccessible to search engine robots, possibly resulting in their removal from the search engine indices.



Here is an alternative function which like file() can be used to retrieve a remote feed, but which imposes a maximum connection time, after which the page will be displayed without the feed.



<?



function fetchUrlWithoutHanging($url)

    {

    // Set maximum number of seconds (can have floating-point) to wait for feed before displaying page without feed

    $numberOfSeconds=4;    



    // Suppress error reporting so Web site visitors are unaware if the feed fails

    error_reporting(0);



    // Extract resource path and domain from URL ready for fsockopen



    $url = str_replace("http://","",$url);

    $urlComponents = explode("/",$url);

    $domain = $urlComponents[0];

    $resourcePath = str_replace($domain,"",$url);



    // Establish a connection

    $socketConnection = fsockopen($domain, 80, $errno, $errstr, $numberOfSeconds);



    if (!$socketConnection)

        {

        // You may wish to remove the following debugging line on a live Web site

        print("<!-- Network error: $errstr ($errno) -->");

        }    // end if

    else    {

        $xml = '';

        fputs($socketConnection, "GET /$resourcePath HTTP/1.0\r\nHost: $domain\r\n\r\n");

    

        // Loop until end of file

        while (!feof($socketConnection))

            {

            $xml .= fgets($socketConnection, 128);

            }    // end while



        fclose ($socketConnection);



        }    // end else



    return($xml);



    }    // end function



?>


The file function will load the entire file before you can do anything to it [remove lines, explode() each line, and so on...]



I wrote a function [ file_v2() ] to help eliminate the restrictions of file(). Below are a few features/abilites file_v2() has over file().



file_v2() features:

 - uses an editable buffer size, for performance tweaking.

 - ability set maximum lines returned[from beginning]

 - optional automatically rtrim the line

 - optional ability to provide a callback function for each array element



Here is the code:



<?php



function file_v2 ( $filename, $return_max_lines=0, $callback_func=null, $do_rtrim=true, $buffer_size=1024 )

{



    // open file pointer

    $open = fopen( $filename, 'rb' );



    // start an array [good coding practice]

    $open_data = array();



    // start an internal line counter [good coding practice]

    $line=0;



    // begin the loop

    while( !feof($open) )

    {

        if( $do_rtrim )

        {

            // add line to array, do an rtrim()

            $open_data[$line] = rtrim(fgets($open, $buffer_size));

        }

        else

        {

            // add line to array

            $open_data[$line] = fgets($open, $buffer_size);

        }



        if( $callback_func != null && function_exists( $callback_func ) )

        {

            eval($callback_func . '($open_data[$line]);');

        }



        // +1 to the internal line counter

        $line++;

        

        if( $return_max_lines > 0 )

        {

            if( $line >= $return_max_lines )

            {

                break;

            }

        }

    }



    // close the file pointer

    fclose($open);



    // return the data

    return $open_data;

}



?>



Example usage:



=========

file_test.txt

=========

01    firstname_1    lastname_1    fake_email@fake_addr1.fk

02    firstname_2    lastname_2    fake_email@fake_addr2.fk

03    firstname_3    lastname_3    fake_email@fake_addr3.fk

04    firstname_4    lastname_4    fake_email@fake_addr4.fk

05    firstname_5    lastname_5    fake_email@fake_addr5.fk

06    firstname_6    lastname_6    fake_email@fake_addr6.fk

07    firstname_7    lastname_7    fake_email@fake_addr7.fk

08    firstname_8    lastname_8    fake_email@fake_addr8.fk

09    firstname_9    lastname_9    fake_email@fake_addr9.fk

10    firstname_10    lastname_10    fake_email@fake_addr10.fk

11    firstname_11    lastname_11    fake_email@fake_addr11.fk

12    firstname_12    lastname_12    fake_email@fake_addr12.fk



=========

test.php

=========

<?php



// we will assume the function is in here somewhere



// create a callback function

function mk_callback( &$input )

{

    $input = explode("\t", $input);

}



$open = file_v2('file_test.txt', 3, 'mk_callback');



// output array using print_r()

print_r($open);



?>



Example will output:

Array

(

    [0] => Array

        (

            [0] => 01

            [1] => firstname_1

            [2] => lastname_1

            [3] => fake_email@fake_addr1.fk

        )



    [1] => Array

        (

            [0] => 02

            [1] => firstname_2

            [2] => lastname_2

            [3] => fake_email@fake_addr2.fk

        )



    [2] => Array

        (

            [0] => 03

            [1] => firstname_3

            [2] => lastname_3

            [3] => fake_email@fake_addr3.fk

        )



)



This is one of my few contributions to this fine world.

Happy coding everybody!



    - Cory Christison


Another way to do mvanbeek at supporting-role dot co dot uk (31 december) config reader.



I've an array $config

<?php

    $array_tmp = file('configfile.txt');

    foreach($array_tmp as $v)

    {

        if ((substr(trim($v),0,1)!=';') && (substr_count($v,'=')>=1))

        {//Line mustn't start with a ';' and must contain at least one '=' symbol.

            $pos = strpos($v, '=');

            $config[trim(substr($v,0,$pos))] = trim(substr($v, $pos+1));

        }

    }

    unset($array_tmp);

?>



The configfile :

    variable  =     value

will be loaded into $config['variable'] = 'value';

it trims spaces near the '=', don't read lines starting with a ';' (it can have spaces and tabs before the ';' ).



Have a nice day :)


I needed a cross platform config file for a project using both perl and php, so I used the perl script in the Perl Cookbook, and wrote the following PHP script. This going in an include file that all the PHP files reference, so the only thing that needs to be do for set up, is to set the location of the config file.



$filename = "/opt/ssis/includes/ssis-config";

$config = file($filename);

reset ($config);

foreach ($config as $line)

     {

     if ( $line == "" ) next($config);           # Ignore blankline

     elseif ( $line == "\n" ) next($config);      # Ignore newline

     elseif ( strstr($line,"#")) next($config); # Ignore comments

     else

          {

          $line = rtrim($line);  # Get rid of newline characters

          $line = ltrim($line);  # Get rid of any leading spaces

          $value = preg_split("/\s*=\s*/", $line, 2); # split by "=" and removing blank space either side of it.

          ${Settings}["$value[0]"] = $value[1]; # Create a new array with all the values.

          }

     }



I am sure there is a neater way of doing it, but all the Config libaries floating arround seemed very complicated. All the config file needs is a series of lines ( key = value ) in plain text.


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


If you want to send a URL via GET to a script and want to open this URL via file() there are problems if there is a & sign in the URL, all after die & sign is cut.



TO fix this an get it working with the & sign in the URL



@$myopenedcontent= implode("", file ("$url"));

$myopenedcontent=eregi_replace('&','{KU}',$myopenedcontent);



so all & signs are replaced by {KU}



before use the file() function you have to rereplace it, the whole code:



$url=eregi_replace('{KU}','&,$url);

@$myopenedcontent= implode("", file ("$url"));

$myopenedcontent=eregi_replace('&','{KU}',$myopenedcontent);

echo "$myopenedcontent";



hope it is helpful ;)



Bye

Afterburner