file_exists
file_put_contents
Filesystem Functions
PHP Manual

# 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() - Lee un archivo entero hacia una matriz
- fgets() - Obtiene una línea desde el apuntador de archivo
- fread() - Lectura de archivos segura con material binario
- readfile() - Imprime un archivo
- file_put_contents() - Escribir una cadena sobre un archivo
- stream_get_contents() - Lee el resto de una secuencia en una cadena
- stream_context_create() - Crear un contexto de secuencia

file_exists
file_put_contents
Filesystem Functions
PHP Manual