(PHP 4, PHP 5)
fopen — Ouvre un fichier ou une URL
$filename
, string $mode
[, bool $use_include_path = false
[, resource $context
]] )
fopen() crée une ressource nommée, spécifiée par
le paramètre filename, sous la forme d'un flux.
filename
Si filename est de la forme "protocole://",
filename est supposé être une URL, et PHP va
rechercher un gestionnaire de protocole adapté pour lire ce fichier.
Si aucun gestionnaire pour ce protocole n'est disponible, PHP va émettre
une alerte qui vous permettra de savoir que vous avez des problèmes dans
votre script, et il tentera d'exploiter filename
comme un fichier classique.
Si PHP décide que le fichier filename est un fichier
local, il va essayer d'ouvrir un flux avec ce fichier. Le fichier doit être
accessible à PHP. Il vous faut donc vous assurer que vous avez les
droits d'accès à ce fichier. Si vous activez le safe mode,
ou la directive open_basedir, d'autres
conditions peuvent aussi s'appliquer.
Si PHP a décidé que filename spécifie
un protocole enregistré, et que ce protocole est enregistré comme
un protocole réseau, PHP s'assurera que la directive
allow_url_fopen est activée.
Si elle est inactive, PHP va émettre une alerte et l'ouverture
va échouer.
Note:
La liste des protocoles supportés est disponible sur Liste des protocoles et des gestionnaires supportés. Certains protocoles (appelés aussi wrappers ou gestionnaires) supportent des context et/ou des options dans le fichier php.ini. Référez-vous aux pages du manuel traitant le protocole, pour connaître la liste des options qui sont disponibles. ( e.g. l'option de php.ini user_agent est utilisée par le gestionnaire http).
Sous Windows, assurez-vous de bien protéger les antislash utilisés dans le chemin du fichier, ou bien utilisez des slashs.
<?php
$handle = fopen("c:\\folder\\resource.txt", "r");
?>
mode
Le paramètre mode spécifie le type d'accès désiré
au flux. Il peut prendre les valeurs suivantes :
mode |
Description |
|---|---|
| 'r' | Ouvre en lecture seule, et place le pointeur de fichier au début du fichier. |
| 'r+' | Ouvre en lecture et écriture, et place le pointeur de fichier au début du fichier. |
| 'w' | Ouvre en écriture seule ; place le pointeur de fichier au début du fichier et réduit la taille du fichier à 0. Si le fichier n'existe pas, on tente de le créer. |
| 'w+' | Ouvre en lecture et écriture ; place le pointeur de fichier au début du fichier et réduit la taille du fichier à 0. Si le fichier n'existe pas, on tente de le créer. |
| 'a' | Ouvre en écriture seule ; place le pointeur de fichier à la fin du fichier. Si le fichier n'existe pas, on tente de le créer. |
| 'a+' | Ouvre en lecture et écriture ; place le pointeur de fichier à la fin du fichier. Si le fichier n'existe pas, on tente de le créer. |
| 'x' |
Crée et ouvre le fichier en écriture seulement ; place le pointeur de
fichier au début du fichier. Si le fichier existe déjà,
fopen() va échouer, en retournant FALSE et
en générant une erreur de niveau E_WARNING.
Si le fichier n'existe pas, fopen() tente de le
créer. Ce mode est l'équivalent des options O_EXCL|O_CREAT
pour l'appel système open(2) sous-jacent.
|
| 'x+' | Crée et ouvre le fichier pour lecture et écriture; le comportement est le même que pour 'x'. |
| 'c' | Ouvre le fichier pour écriture seulement. Si le fichier n'existe pas, il sera crée, s'il existe, il n'est pas tronqué (contrairement à 'w') et l'appel à la fonction n'échoue pas (comme dans le cas de 'x'). Le pointeur du fichier est positionné au début. Ce mode peut être utile pour obtenir un verrou (voyez flock()) avant de tenter de modifier le fichier, utiliser 'w' pourrait tronquer le fichier avant d'obtenir le verrou (vous pouvez toujours tronquer grâce à ftruncate()). |
| 'c+' | Ouvre le fichier pour lecture et écriture, le comportement est le même que pour le mode 'c'. |
Note:
Les systèmes d'exploitation utilisent différents caractères pour les nouvelles lignes. Lorsque vous écrivez un fichier texte, et insérez une nouvelle ligne, vous devez utiliser le bon caractère pour votre système d'exploitation. Les systèmes Unix utilisent \n comme nouvelle ligne, les systèmes Windows utilisent \r\n, et les systèmes Macintosh utilisent \r.
Si vous n'utilisez pas le bon caractère de nouvelle ligne lors de l'écriture de vos fichiers, vous risquez d'ouvrir vos fichiers avec des applications qui donneront un aspect 'bizarre' au texte.
Windows propose un mode de traduction ('t'), qui va traduire automatiquement les caractères \n en \r\n lorsque vous travaillez sur le fichier. À l'inverse, vous pouvez utiliser l'option 'b' pour forcer le fichier a être écrit en mode binaire, sans traduction des données. Pour utiliser ces options, ajoutez 'b' ou 't' comme dernier caractère du paramètre
mode.Le mode de traduction par défaut dépend de l'interface SAPI et de la version de PHP que vous utilisez. Nous vous recommandons de toujours spécifier les options de traductions pour des raisons de portabilité. Vous devriez utiliser 't' lorsque vous écrivez des fichiers de texte, et le caractère \n pour définir vos fin de ligne, dans les scripts, mais que vous vous attendez à ce que le fichier soit relu par une application comme Notepad. Vous devriez toujours utiliser l'option 'b' dans les autres cas.
Si vous ne précisez pas 'b' lorsque vous travaillez avec des fichiers binaires, vous pourriez rencontrer des problèmes avec vos données, comme des images corrompues ou des caractères \r\n inopinés.
Note:
Pour des raisons de portabilité, il est recommandé de toujours utiliser l'option 'b' lorsque vous ouvrez des fichiers avec fopen().
Note:
À nouveau, pour des raisons de portabilité, il est fortement recommandé de réécrire les scripts qui utilisent l'option 't', pour qu'ils utilisent le bon caractère de nouvelle ligne, et le mode 'b'.
use_include_path
Le troisième paramètre optionnel use_include_path
peut être défini à 1 ou à TRUE pour chercher le fichier dans
l'include_path.
contextNote: Le support de contexte a été ajouté en PHP 5.0.0. Pour une description des contextes, référez-vous à Flux.
Retourne une ressource représentant le pointeur de fichier, ou
FALSE si une erreur survient.
Si l'ouverture échoue, une alerte
E_WARNING sera générée. Vous pouvez utiliser
le caractère @
pour supprimer cette alerte.
| Version | Description |
|---|---|
| 5.2.6 | Les options 'c' et 'c+' ont été ajoutées. |
| 4.3.2 | Depuis PHP 4.3.2, le mode par défaut est le mode binaire pour toutes les plates-formes qui font la distinction entre les modes binaire et texte. Si vous rencontrez des problèmes dans vos scripts après une mise à jour, essayez d'utiliser le flag 't' en attendant que vous rendiez votre script plus portable comme mentionné ci-dessus. |
| 4.3.2 | Les options 'x' et 'x+' ont été ajoutées. |
Exemple #1 Exemple avec fopen()
<?php
$handle = fopen("/home/rasmus/file.txt", "r");
$handle = fopen("/home/rasmus/file.gif", "wb");
$handle = fopen("http://www.example.com/", "r");
$handle = fopen("ftp://user:[email protected]/somefile.txt", "w");
?>
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.
Note: Lorsque le safe-mode est activé, PHP vérifie si le fichier/dossier que vous allez utiliser a le même UID que le script qui est actuellement exécuté.
Note:
Si vous rencontrez des problèmes en lecture ou écriture de fichier et que vous utilisez PHP en version module de serveur, n'oubliez pas que les fichiers auxquels vous accédez ne sont pas nécessairement accessibles au processus serveur.
Note:
Cette fonction peut également réussir lorsque
filenameest un dossier. Si vous avez un doute sur le fait quefilenamesoit un fichier ou un dossier, vous pouvez utiliser la fonction is_dir() avant d'utiliser la fonction fopen().