(PHP 4 >= 4.3.0, PHP 5)
file_get_contents — Reads entire file into a 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.
Informacja: If you're opening a URI with special characters, such as spaces, you need to encode the URI with urlencode().
Name of the file to read.
For all versions prior to PHP 6, this parameter is called use_include_path and is a bool. The flags parameter is only available since PHP 6. If you use an older version and want to search for filename in the include path, this parameter must be TRUE. Since PHP 6, you have to use the FILE_USE_INCLUDE_PATH flag instead.
The value of flags can be any combination of the following flags (with some restrictions), joined with the binary OR (|) operator.
Flag | Description |
---|---|
FILE_USE_INCLUDE_PATH | Search for filename in the include directory. See include_path for more information. |
FILE_TEXT | As of PHP 6, the default encoding of the read data is UTF-8. You can specify a different encoding by creating a custom context or by changing the default using stream_default_encoding(). This flag cannot be used with FILE_BINARY. |
FILE_BINARY | With this flag, the file is read in binary mode. This is the default setting and cannot be used with FILE_TEXT. |
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.
The offset where the reading starts.
Maximum length of data read.
The function returns the read data or FALSE on failure.
Przykład #1 Get and output the source of the homepage of a website
<?php
$homepage = file_get_contents('http://www.example.com/');
echo $homepage;
?>
Przykład #2 Searching within the include_path
<?php
// <= PHP 5
$file = file_get_contents('./people.txt', true);
// > PHP 5
$file = file_get_contents('./people.txt', FILE_USE_INCLUDE_PATH);
?>
Przykład #3 Reading a section of a file
<?php
// Read 14 characters starting from the 21st character
$section = file_get_contents('./people.txt', NULL, NULL, 20, 14);
var_dump($section);
?>
Powyższy przykład wyświetli coś podobnego do:
string(14) "lle Bjori Ro"
Przykład #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);
?>
Wersja | Opis |
---|---|
5.0.0 | Added context support. |
5.1.0 | Added the offset and maxlen parameters. |
6.0.0 | The use_include_path parameter was replaced by the flags parameter. |
Informacja: Ta funkcja jest bezpieczna dla danych binarnych.
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.
Łącząc się przez SSL, serwer Microsoft IIS narusza reguły protokołu przez zamknięcie połączenia bez wysłania wskaźnika close_notify. Po przesłaniu całości danych PHP zgłosi to jako "SSL: Fatal Protocol Error". Aby obejść ten błąd, wystarczy obniżyć poziom raportowania błędów error_reporting, tak aby nie były wyświetlane ostrzeżenia. PHP 4.3.7 i nowsze wersje same wykrywają błąd serwera IIS przy otwieraniu strumienia https:// i za pomocą nakładki i pomijają ostrzeżenia. Używając funkcji fsockopen() do otwarcia gniazda ssl:// programista sam musi zadbać o wyłączenie ostrzeżeń.