Last updated: Fri, 04 Jul 2008

file_get_contents

(PHP 4 >= 4.3.0, PHP 5)

file_get_contents — Lee un archivo entero en una cadena

Descripción

string file_get_contents ( string $nombre_archivo [, int $banderas [, resource $contexto [, int $desplazamiento [, int $long_max ]]]] )

Esta función es similar a file(), con la excepción de que file_get_contents() devuelve el archivo en un valor string, comenzando en el desplazamiento especificado y hasta long_max bytes. En caso de fallo, file_get_contents() devolverá FALSE.

file_get_contents() es el modo preferido para leer los contenidos de un archivo en una cadena. Esta función usa las técnicas de asignación de memoria que soporte su SO para incrementar su rendimiento.

Note: Si está abriendo una URI con caracteres especiales, como espacios, necesita codificar la URI con urlencode().

Lista de parámetros

nombre_archivo

Nombre del archivo a leer.

banderas

Warning

Para todas las versiones anteriores a PHP 6, este parámetro es llamado usar_ruta_inclusion y es un valor tipo bool. El parámetro banderas está disponible únicamente a partir de PHP 6. Si usa una versión anterior y desea buscar por nombre_archivo en la ruta de inclusión, este parámetro debe ser TRUE. Desde PHP 6, debe usar la bandera FILE_USE_INCLUDE_PATH en su lugar.

El valor de banderas puede ser una combinación de los siguientes valores (con algunas restricciones), unidos mediante el operador binario OR (|).

**Banderas disponibles**
Bandera	Descripción
`FILE_USE_INCLUDE_PATH`	Buscar por `nombre_archivo` en el directorio de inclusiones. Vea include_path para más información.
`FILE_TEXT`	Si la semántica unicode está habilitada, la codificación predeterminada para los datos leídos es UTF-8. Es posible especificar una codificación diferente creando un contexto personalizado o modificando el predeterminado mediante stream_default_encoding(). Esta bandera no puede ser usada junto con `FILE_BINARY`.
`FILE_BINARY`	Con esta bandera, el archivo es leído en modo binario. Este es el comportamiento predeterminado y no puede ser usado junto con `FILE_TEXT`.

contexto

Un recurso tipo contexto creado con stream_context_create(). Si no necesita usar un contexto personalizado, puede saltar este parámetro con NULL.

desplazamiento

El desplazamiento en donde inicia la lectura.

long_max

Longitud máxima de los datos leídos.

Valores retornados

La función devuelve los datos leídos o FALSE en caso de fallo.

Registro de cambios

Versión	Descripción
5.0.0	Se agregó soporte para contextos.
5.1.0	Se agregaron los parámetros `desplazamiento` y `long_max` .
6.0.0	El parámetro `usar_ruta_inclusion` fue reemplazado por el parámetro `banderas` .

Notes

Note: Esta función es segura binariamente.

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

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

file_put_contents

file_exists

Last updated: Fri, 04 Jul 2008

add a note User Contributed Notes
file_get_contents

joachimb at gmail dot com
15-Apr-2008 11:38


Setting the timeout properly without messing with ini values:





<?php


$ctx = stream_context_create(array(


    'http' => array(


        'timeout' => 1


        )


    )


);


file_get_contents("http://example.com/", 0, $ctx);


?>

3n1gm4 [at] gmail [dot] com
02-Apr-2008 11:12


This is a nice and simple substitute to get_file_contents() using curl, it returns FALSE if $contents is empty.



<?php

function curl_get_file_contents($URL)

    {

        $c = curl_init();

        curl_setopt($c, CURLOPT_RETURNTRANSFER, 1);

        curl_setopt($c, CURLOPT_URL, $URL);

        $contents = curl_exec($c);

        curl_close($c);



        if ($contents) return $contents;

            else return FALSE;

    }

?>



Hope this help, if there is something wrong or something you don't understand let me know :)

jose dot nobile at gmail dot com
29-Jan-2008 08:29


<?PHP

//PHP 4.2.x Compatibility function

if (!function_exists('file_get_contents')) {

      function file_get_contents($filename, $incpath = false, $resource_context = null)

      {

          if (false === $fh = fopen($filename, 'rb', $incpath)) {

              trigger_error('file_get_contents() failed to open stream: No such file or directory', E_USER_WARNING);

              return false;

          }

  

          clearstatcache();

          if ($fsize = @filesize($filename)) {

              $data = fread($fh, $fsize);

          } else {

              $data = '';

              while (!feof($fh)) {

                  $data .= fread($fh, 8192);

              }

          }

  

          fclose($fh);

          return $data;

      }

  }

?>

php [spat] hm2k.org
16-Jan-2008 12:58


I decided to make a similar function to this, called file_post_contents, it uses POST instead of GET to call, kinda handy...



<?php

function file_post_contents($url,$headers=false) {

    $url = parse_url($url);



    if (!isset($url['port'])) {

      if ($url['scheme'] == 'http') { $url['port']=80; }

      elseif ($url['scheme'] == 'https') { $url['port']=443; }

    }

    $url['query']=isset($url['query'])?$url['query']:'';



    $url['protocol']=$url['scheme'].'://';

    $eol="\r\n";



    $headers =  "POST ".$url['protocol'].$url['host'].$url['path']." HTTP/1.0".$eol. 

                "Host: ".$url['host'].$eol. 

                "Referer: ".$url['protocol'].$url['host'].$url['path'].$eol. 

                "Content-Type: application/x-www-form-urlencoded".$eol. 

                "Content-Length: ".strlen($url['query']).$eol.

                $eol.$url['query'];

    $fp = fsockopen($url['host'], $url['port'], $errno, $errstr, 30); 

    if($fp) {

      fputs($fp, $headers);

      $result = '';

      while(!feof($fp)) { $result .= fgets($fp, 128); }

      fclose($fp);

      if (!$headers) {

        //removes headers

        $pattern="/^.*\r\n\r\n/s";

        $result=preg_replace($pattern,'',$result);

      }

      return $result;

    }

}

?>

francois hill
03-Dec-2007 05:56


Seems file looks for the file inside the current working (executing) directory before looking in the include path, even with the FILE_USE_INCLUDE_PATH flag specified.



Same behavior as include actually.



By the way I feel the doc is not entirely clear on the exact order of inclusion (see include). It seems to say the include_path is the first location to be searched, but I have come across at least one case where the directory containing the file including was actually the first to be searched.



Drat.

bearachute at gmail dot com
11-Jul-2007 11:38


If you're having problems with binary and hex data:



I had a problem when trying to read information from a ttf, which is primarily hex data. A binary-safe file read automatically replaces byte values with their corresponding ASCII characters, so I thought that I could use the binary string when I needed readable ASCII strings, and bin2hex() when I needed hex strings.



However, this became a problem when I tried to pass those ASCII strings into other functions (namely gd functions). var_dump showed that a 5-character string contained 10 characters, but they weren't visible. A binary-to-"normal" string conversion function didn't seem to exist and I didn't want to have to convert every single character in hex using chr().



I used unpack with "c*" as the format flag to see what was going on, and found that every other character was null data (ordinal 0). To solve it, I just did



str_replace(chr(0), "", $string);



which did the trick.



This took forever to figure out so I hope this helps people reading from hex data!

tobsn at php dot net
02-May-2007 06:26


you'll find the http response headers in: $http_response_header



;o)

Greg Ambrose (greg at catalina-it dot com dot au)
17-Apr-2007 06:37


[Editors note: As of PHP 5.2.1 you can specify `timeout` context option and pass the context to file_get_contents()]





The only way I could get get_file_contents() to wait for a very slow http request was to set the socket timeout as follows.





 ini_set('default_socket_timeout',    120);    


$a = file_get_contents("http://abcxyz.com");





Other times like execution time and input time had no effect.

siegfri3d at gmail dot com
05-Dec-2006 09:52


Use the previous example if you want to request the server for a special part of the content, IF and only if the server accepts the method.

If you want a simple example to ask the server for all the content, but only save a portion of it, do it this way:

<?

$content=file_get_contents("http://www.google.com",FALSE,NULL,0,20);

echo $content;

?>



This will echo the 20 first bytes of the google.com source code.

fcicqbbs at gmail dot com
04-Aug-2006 10:55


the bug #36857 was fixed.

http://bugs.php.net/36857



Now you may use this code,to fetch the partial content like this:

<?php

$context=array('http' => array ('header'=> 'Range: bytes=1024-', ),);

$xcontext = stream_context_create($context);

$str=file_get_contents("http://www.fcicq.net/wp/",FALSE,$xcontext);

?>

that's all.

richard dot quadling at bandvulc dot co dot uk
15-Nov-2005 11:47


If, like me, you are on a Microsoft network with ISA server and require NTLM authentication, certain applications will not get out of the network. SETI@Home Classic and PHP are just 2 of them.



The workaround is fairly simple.



First you need to use an NTLM Authentication Proxy Server. There is one written in Python and is available from http://apserver.sourceforge.net/. You will need Python from http://www.python.org/.



Both sites include excellent documentation.



Python works a bit like PHP. Human readable code is handled without having to produce a compiled version. You DO have the opportunity of compiling the code (from a .py file to a .pyc file).



Once compiled, I installed this as a service (instsrv and srvany - parts of the Windows Resource Kit), so when the server is turned on (not logged in), the Python based NTLM Authentication Proxy Server is running.



Then, and here is the bit I'm really interested in, you need to tell PHP you intend to route http/ftp requests through the NTLM APS.



To do this, you use contexts.



Here is an example.



<?php



// Define a context for HTTP.

$aContext = array(

    'http' => array(

        'proxy' => 'tcp://127.0.0.1:8080', // This needs to be the server and the port of the NTLM Authentication Proxy Server.

        'request_fulluri' => True,

        ),

    );

$cxContext = stream_context_create($aContext);



// Now all file stream functions can use this context.



$sFile = file_get_contents("http://www.php.net", False, $cxContext);



echo $sFile;

?>



Hopefully this helps SOMEONE!!!

aidan at php dot net
31-Jan-2005 08:23


This functionality is now implemented in the PEAR package PHP_Compat.



More information about using this function without upgrading your version of PHP can be found on the below link:



http://pear.php.net/package/PHP_Compat

add a note

file_put_contents

file_exists

Last updated: Fri, 04 Jul 2008