file_get_contents

(PHP 4 >= 4.3.0, PHP 5, PHP 7)

file_get_contents — Reads entire file into a string

Descrierea

file_get_contents ( string $filename [, bool $use_include_path = FALSE [, resource $context [, int $offset = 0 [, int $maxlen ]]]] ) : string

This function is similar to file(), except that file_get_contents() returns the file in a string, starting at the specified offset up to maxlen bytes. On failure, file_get_contents() will return FALSE.

file_get_contents() is the preferred way to read the contents of a file into a string. It will use memory mapping techniques if supported by your OS to enhance performance.

Notă:

If you're opening a URI with special characters, such as spaces, you need to encode the URI with urlencode().

Parametri

filename

Name of the file to read.

use_include_path

Notă:

The FILE_USE_INCLUDE_PATH constant can be used to trigger include path search. This is not possible if strict typing is enabled, since FILE_USE_INCLUDE_PATH is an int. Use TRUE instead.

context

A valid context resource created with stream_context_create(). If you don't need to use a custom context, you can skip this parameter by NULL.

offset

The offset where the reading starts on the original stream. Negative offsets count from the end of the stream.

Seeking (offset) is not supported with remote files. Attempting to seek on non-local files may work with small offsets, but this is unpredictable because it works on the buffered stream.

maxlen

Maximum length of data read. The default is to read until end of file is reached. Note that this parameter is applied to the stream processed by the filters.

Valorile întoarse

The function returns the read data sau FALSE în cazul eșecului.

Avertizare

Această funcție poate întoarce valoarea Boolean FALSE, dar poate de asemenea întoarce o valoare non-Boolean care evaluează în FALSE. Vă rugăm să citiți secțiunea despre tipul Boolean pentru informații suplimentare. Utilizați operatorul === pentru a verifica valoarea întoarsă de această funcție.

Erori/Excepții

An E_WARNING level error is generated if filename cannot be found, maxlength is less than zero, or if seeking to the specified offset in the stream fails.

Exemple

Example #1 Get and output the source of the homepage of a website

<?php
$homepage = file_get_contents('http://www.example.com/');
echo $homepage;
?>

Example #2 Searching within the include_path

<?php
// If strict types are enabled i.e. declare(strict_types=1);
$file = file_get_contents('./people.txt', true);
// Otherwise
$file = file_get_contents('./people.txt', FILE_USE_INCLUDE_PATH);
?>

Example #3 Reading a section of a file

<?php
// Read 14 characters starting from the 21st character
$section = file_get_contents('./people.txt', FALSE, NULL, 20, 14);
var_dump($section);
?>

Exemplul de mai sus va afișa ceva similar cu:

string(14) "lle Bjori Ro"

Example #4 Using stream contexts

<?php
// Create a stream
$opts = array(
  'http'=>array(
    'method'=>"GET",
    'header'=>"Accept-language: en\r\n" .
              "Cookie: foo=bar\r\n"
  )
);

$context = stream_context_create($opts);

// Open the file using the HTTP headers set above
$file = file_get_contents('http://www.example.com/', false, $context);
?>

Istoricul schimbărilor

Versiune Descriere
7.1.0 Support for negative offsets has been added.
5.1.0 Added the offset and maxlen parameters.

Note

Notă: Această funcție acceptă și date binare.

Sfat

Un URL poate fi utilizat în calitate de denumire a fișierului în această funcție dacă învelișurile fopen au fost activate. Accesați fopen() pentru mai multe detalii despre modul de specificare a denumirii fișierului. Accesați Supported Protocols and Wrappers pentru referințe la informații despre posibilitățile pe care le oferă diferite învelișuri, note despre utilizarea lor și informații despre variabile predefinite pe care le oferă.

Avertizare

La utilizarea SSL, Microsoft IIS va viola protocolul prin închiderea conexiunii fără a trimite un indicator close_notify. PHP va raporta aceasta ca "SSL: Fatal Protocol Error" (eroare fatală de protocol) când se ajunge la sfârșitul datelor. Pentru a evita aceasta coborât nivelul error_reporting pentru a nu include avertizări. PHP poate detecta soft-ul de server IIS care produce astfel de greșeli când deschideți fluxul utilizând învelișul https:// și va suprima automat avertizările. La utilizarea fsockopen() pentru a crea un socket ssl:// programatorul este responsabil să detecteze și să suprime această avertizare.

A se vedea și