(PHP 4 >= 4.3.0, PHP 5)
file_get_contents — Lit tout un fichier dans une chaîne
$filename
[, bool $use_include_path = false
[, resource $context
[, int $offset = -1
[, int $maxlen
]]]] )
Identique à la fonction file(), hormis le fait que
file_get_contents() retourne le fichier
filename dans une chaîne, à partir
de la position offset, et jusqu'à
maxlen octets.
En cas d'erreur, file_get_contents() retourne
FALSE.
file_get_contents() est la façon recommandée pour lire le contenu d'un fichier dans une chaîne de caractères. Elle utilisera un buffer en mémoire si ce mécanisme est supporté par votre système, afin d'améliorer les performances.
Note:
Si vous ouvrez une URI avec des caractères spéciaux, comme des espaces, vous devez encoder cette URI avec la fonction urlencode().
filenameNom du fichier à lire.
use_include_pathNote:
Depuis PHP 5, la constante
FILE_USE_INCLUDE_PATHpeut être utilisée pour déclencher la recherche dans le chemin d'inclusion.
context
Une ressource de contexte valide, créée avec la fonction
stream_context_create(). Si vous n'avez
pas besoin d'utiliser un contexte particulier, vous pouvez
ignorer ce paramètre en affectant la valeur NULL.
offsetLa position à partir de laquelle on commence à lire dans le flux original.
Le déplacement dans le fichier (offset) n'est
pas supporté sur des fichiers distants. Si vous tentez de vous déplacer
dans un fichier qui n'est pas un fichier local peut fonctionner sur
les petits déplacements, mais le comportement peut ne pas être attendu
car le processus utilise le flux du buffer.
maxlenLa taille maximale des données à lire. Le comportement par défaut est de lire jusqu'à la fin du fichier. Ce paramètre s'applique sur le flux traité par les filtres.
Retourne les données lues ou FALSE si une erreur survient.
Cette fonction peut
retourner FALSE, mais elle peut aussi retourner une valeur équivalent à
FALSE. Veuillez lire la section sur
les booléens pour plus d'informations.
Utilisez l'opérateur ===
pour tester la valeur de retour exacte de cette fonction.
Émets une alerte de type E_WARNING si,
filename ne peut être trouvé, si le
paramètre maxlength est plus petit que zéro,
ou si le déplacement à la position offset
spécifié dans le flux échoue.
Exemple #1 Lit et affiche le code HTML d'un site Web
<?php
$homepage = file_get_contents('http://www.example.com/');
echo $homepage;
?>
Exemple #2 Recherche un fichier dans le include_path
<?php
// avant PHP 5
$file = file_get_contents('./people.txt', true);
// depuis PHP 5
$file = file_get_contents('./people.txt', FILE_USE_INCLUDE_PATH);
?>
Exemple #3 Lit une section d'un fichier
<?php
// Lit 14 caractères à partir du 20ème
$section = file_get_contents('./people.txt', NULL, NULL, 20, 14);
var_dump($section);
?>
L'exemple ci-dessus va afficher quelque chose de similaire à :
string(14) "lle Bjori Ro"
Exemple #4 Utilisation des contextes de flux
<?php
// Création d'un flux
$opts = array(
'http'=>array(
'method'=>"GET",
'header'=>"Accept-language: en\r\n" .
"Cookie: foo=bar\r\n"
)
);
$context = stream_context_create($opts);
// Accès à un fichier HTTP avec les entêtes HTTP indiqués ci-dessus
$file = file_get_contents('http://www.example.com/', false, $context);
?>
| Version | Description |
|---|---|
| 5.1.0 |
Ajout des paramètres offset et
maxlen.
|
| 5.0.0 | Ajout du support du contexte. |
Note: Cette fonction gère les chaînes binaires.
Vous pouvez utiliser une URL comme nom de fichier avec cette fonction, si le gestionnaire fopen a été activé. Voyez fopen() pour plus de détails sur la façon de spécifier le nom du fichier. Reportez-vous aux Liste des protocoles et des gestionnaires supportés pour plus d'informations sur les capacités des différents gestionnaires, les notes sur leur utilisation, ainsi que les informations sur leurs variables prédéfinies fournies.
Lorsque vous utilisez SSL, le serveur IIS de Microsoft violera le protocole en fermant la connexion sans envoyer l'indicateur close_notify. PHP le reportera en tant que "SSL: Fatal Protocol Error" quand vous arrivez à la fin des données. L'astuce est de baisser le niveau de la directive error_reporting pour ne pas inclure les alertes. À partir de PHP 4.3.7, le bogue est détecté automatiquement lors de l'ouverture du flux en utilisant https:// et supprimera cet avertissement pour vous. Si vous utilisez fsockopen() pour créer un socket ssl://, vous devez vous occuper vous-même de supprimer l'erreur.