PHP et les fichiers texte

Une base de données permet de stocker de façon permanente et structurée un grand nombre de données. Or pour certains traitements il suffit de stocker qu'un nombre limité de données ; dans ce cas utiliser une base de données c'est "tuer une mouche avec un canon" ; le recours à un fichier texte est alors préférable. PHP propose de nombreuses fonctions pour manipuler les fichiers texte.

Lire la totalité d'un fichier texte

Un fichier de type 'text'

Il se nomme "liste.txt" et comprend la liste des poissons observés sur un site de plongée.
Le contenu de ce fichier texte :

requins	petite roussette
requins	grande roussette
plats	plie
plats	sole
gadidés	morue
gadidés	tacaud

Sur une ligne le groupe et le nom de l'espèce. Donc il faut lire que le petite roussette appartient au groupe des requins et que la plie est un (poisson) plat et la morue appartient au groupe des gadidés.

Programme pour lire ce fichier

PHP n'est pas avare d'outils. Trois fonctions permettent de lire la totalité d'un fichier. Ces trois fonctions ne se contentent pas de lire la totalité du fichier, elle l'ouvre au préalable puis le ferme. Il s'agit donc de fonctions de haut niveau.

Le code du document PHP

...
	<form action = "#"  method ='get'>
		<button type = 'submit' name ="go">Exécutez le script PHP  !</button>
	</form>
	<h4>
    <?php
	if(isset($_GET['go']))
	{
		echo '<p>La fonction file_get_content()</p>' ; 
        $contenu = file_get_contents('liste.txt');
		echo $contenu; 
        echo '<hr>';
            			 
		echo '<p>La fonction readfile()</p>' ; 
        readfile('liste.txt');
		echo '<hr>';
			
		echo '<p>La fonction file()</p>' ; 
        $tableau = file('liste.txt');
		print_r($tableau); 
		echo '<hr>';
			 
		foreach ($tableau as $element)		
			{ echo "$element <br>" ;   }
        echo '<hr>';
	} // fin test
	else echo "Cliquez sur le bouton de commande ! "; 	
    ?> 
	</h4>
...

Notez le formulaire qui permet de lancer l'exécution du script PHP.

Les fonctions file_get_contents() & readfile() retournent le contenu du fichier sous forme d'une chaine.

Avec la première fonction il faut ensuite un echo pour afficher cette chaine alors que la deuxième fonction produit la chaine et l'affiche.

La fonction file() retourne le contenu du fichier sous forme d'un 'array' ; Chaque ligne du fichier texte devenant un élément de ce tableau indicé.
On peut donc utiliser ensuite la fonction print_r() ou une boucle foreach() pour afficher chaque élément du tableau. Dans l'exemple je fais les deux !

Le rendu

Lire une partie d'un fichier texte

fread()
fgets()
fgetc()

Attention ces fonctions n'ouvrent pas le fichier. Il faut donc au préalable l'ouvrir en lecture seule.

Ouvrir un fichier texte

Pour ouvrir un fichier (et uniquement ouvrir) il faut utiliser la fonction fopen(cheminFichier,mode d'ouverture).
Pour que le chemin se résume au nom du fichier texte je vous recommande de placer dans le même dossier les fichiers et les documents PHP qui les manipulent.

Mode d'ouverture d'un fichier

Ci-dessous les principales valeurs du paramètre mode d'ouverture de la fonction fopen().

r : ouvre le fichier en lecture seule.
r+ : ouvre le fichier en lecture et en écriture.
a : ouvre le fichier en ajout (sauvegarde de l'existant) ; si le fichier n'existe pas il est créé.
a+ : ouvre le fichier en ajout et lecture ; si le fichier n'existe pas il est créé.

r & r+ : le curseur pointe le début de fichier
a & a+ : le curseur pointe la fin de fichier

La fonction fread()

Cette fonction accepte deux arguments. Le premier est le fichier à lire et le deuxième précise le nombre d'octets qu'il faut lire.

Le code du document PHP

Le début du code est identique à la page précédent : un formulaire pour appeler le script.
Le code (extrait) : ... <h4> <php if(isset($_GET['go'])) { // lire les 50 premiers octets echo "<p>Les 50 premiers octets : <br> "; $fichier = fopen('liste.txt', 'r'); echo fread($fichier,50); echo '<hr>'; $taille = filesize('liste.txt'); echo "Taille du fichier : $taille octets"; echo '<hr>'; echo "<p>Lire la totalité du fichier : <br>"; // lire jusqu'à la fin du fichier $fichier = fopen('liste.txt', 'r'); echo fread($fichier,$taille); echo '<hr>'; // lire tout le fichier sauf les 30 derniers octets echo "<p>Récupérer la totalité du fichier sauf les 30 derniers octets : <br> "; $fichier = fopen('liste.txt', 'r'); echo fread($fichier, $taille-30); echo '<hr>'; } // fin test ?> </h4> ...

Notez l'ouverture du fichier en lecture seule.
La fonction filesize() précise la taille du fichier en octets.

Le rendu

Autre solution pour le script

Ce script est maladroit car il y a trois instructions fopen().
Il suffit d'une seule ouverture (en lecture seule) puis à chaque fois il faut gérer le curseur pour pointer de nouveau le début de fichier. Il faut donc utiliser la fonction fseek() qui déplace le curseur.

Le script amélioré (extrait) : // le début est inchangé // lire jusqu'à la fin du fichier echo "<p>Récupérer la totalité du fichier : <br>"; fseek($fichier,0); echo fread($fichier,$taille); echo '<hr>'; // lire tout le fichier sauf les 30 derniers octets echo "<p>Récupérer la totalité du fichier sauf les 30 derniers octets : <br> "; fseek($fichier,0); echo fread($fichier, $taille-30); echo '<hr>'; fclose($fichier);

L'instruction fopen() est remplacée 2 fois par l'instruction fseek(). Le deuxième argument de cette fonction est 0 ; ce qui signifie "pointer le début de fichier".
Notez l'instruction pour fermer le fichier ouvert.

La fermeture du fichier n’est pas obligatoire mais conseillée : libère des ressources.

La fonction gets()

Cette fonction permet de lire le fichier ligne par ligne.

Le script

...
<h4>
<?php
if(isset($_GET['go']))
{     
    $fichier = fopen('liste.txt','r');
	while(!feof($fichier))
	// tant que la fin de fichier n'est pas détectée
	{
      $ligne = fgets($fichier);
	  echo "$ligne <br>";
	} // fin boucle
} // fin test
?>
</h4>
...

La fonction feof() permet de détecter la fin de fichier.
Cette fonction retourne un booléen d'où la condition du while() : while(!feof($fichier)). Ce qui veut dire "tant que la fin de fichier n'est pas détectée"

Le rendu

Le rendu est très satisfaisant.

Autre solution

J'utilise la fonction count() qui peut s'appliquer qu'à un objet 'array'. Aussi dois-je alors ouvrir le fichier avec la fonction file() qui, je le rappelle, retourne le contenu du fichier sous forme d'un tableau indicé. <?php $fichier = file('liste.txt'); $nombre = count($fichier); for($i = 0; $i < $nombre; $i++) // avec la fonction nl2br pour ajouter les sauts de lignes { echo nl2br($fichier[$i]);} ?>

La fonction nl2br() crée un saut de ligne.

La fonction fgetc()

Cette fonction permet de lire un fichier caractère par caractère.
Un espace est un caractère.

Le script

...
<h4>
<?php
if(isset($_GET['go']))
{     
	$fichier = fopen('liste.txt','r');
	while(!feof($fichier))
	// tant que la fin de fichier n'est pas détectée
	{
     $caractere = fgetc($fichier);
	 echo "$caractere - ";
    }
} // fin test
?>
</h4>
...

Ce script ressemble beaucoup au précédent.

Le rendu

Écrire dans un fichier

Passons maintenant à l'écriture dans un fichier.
Thème : un nombre entier est généré de façon aléatoire. Ce nombre doit être inséré dans un fichier texte.

La fonction file_put_contents()

Pour écrire dans un fichier nous pouvons utiliser la fonction file_put_contents() qui ouvre et écrit dans le fichier.

Cette fonction va accepter en argument le chemin vers le fichier et les données à écrire.
Si le fichier spécifié n’existe pas, alors il sera créé et s'il existe les données existantes seront écrasées.

Le code

...
	<form action = "#"  method ='get' style ="border : none" >
		<button type = 'submit' name ="go">Exécutez le script PHP  !</button>
	</form>
	<h4>
<?php
	if(isset($_GET['go']))
	{
		$alea = rand(100,999); 
		$chaine = "nombre entier généré est $alea"; 
        file_put_contents('fichier2.txt', $chaine);
			
		$contenu = file_get_contents('fichier2.txt');
		echo "Nouveau contenu du fichier : $contenu"; 
	}
?&t;
</h4>
...

Je génère un entier de façon aléatoire compris entre 100 et 999.
Cette valeur est écrite dans le fichier 'fichier2.txt'.
Ce fichier n'existant pas il sera créé lors du premier essai.
Pour les essais suivants, le contenu sera écrasé et remplacé par une nouvelle chaine.

Le rendu

Actualisez la page puis recliquez sur le bouton de soumission.
Vous constatez que la ligne unique du fichier est modifiée.

Ajouter dans un fichier texte

Nous voulons que la nouvelle insertion dans 'fichier2.txt' s'ajoute à l'existant ; donc pas d'écrasement de l'existant.

Première solution

Nous allons utiliser la fonction file_put_contents() mais avec une astuce. Pour sauvegarder l'existant, l'astuce consiste à récupérer le contenu d’origine dans une variable, puis à concaténer le contenu de cette variable avec la nouvelle insertion.
Dans une seconde étape la chaine découlant de la concaténation écrase le contenu antérieur.

Le code du document PHP - extrait

// ajout_dans_fichier1.php
<h4>
<?php 
if(isset($_GET['go']))
{	
	echo '<pre>';
	$ancien = file_get_contents('fichier2.txt');
	echo $ancien; 
	echo '</pre>';
					
	$alea = rand(100,999); 
	$ajout = "nombre entier généré est $alea  \n "; 
			
	$nouveau = $ancien . ' ' .$ajout ;
	file_put_contents('fichier2.txt', $nouveau); 
} //fin test
...
?> 
</h4>
...

Notez l'utilisation des fonctions file_get_contents() puis file_put_contents(). Donc on est successivement en lecture pui en écriture.
Et entre les deux la concaténation de l'ancien contenu avec l'insertion.
J'insère un saut de ligne : \n
Il faut que ces sauts de ligne soient pris en compte lors de l'affichage du contenu d'où l'emploi de la balise double PRE.

Capture d'écran du contenu de "fichier2.txt"

À chaque exécution du programme il y a affichage d'une ligne supplémentaire à la suite des données anciennes.

Solution plus orthodoxe

Je vous propose maintenant une solution plus classique. // ajout_dans_fichier2.php ... <h4> <?php $fichier = fopen('fichier2.txt', 'a+'); $alea = rand(100,999); $ajout = "nombre entier généré est $alea \n "; fputs($fichier,$ajout); echo '<pre>'; $contenu = file_get_contents('fichier2.txt'); echo $contenu; echo '</pre>'; fclose ($fichier); ?> </h4> ...

Le fichier 'fichier2.txt' est ouvert en "a+" (ajout et lecture).
Un nombre aléatoire est généré ainsi qu'un saut de ligne.
Cette chaine est ajoutée au fichier grâce à la fonction fputs() et au mode d'ouverture du fichier (a).
Puis la totalité du contenu est affichée avec prise en compte des sauts de ligne (emploi de la balise double PRE).

fputs() est un alias de fwrite(). En d'autres termes j'aurais pu utiliser la fonction fwrite().

Consignes

Si vous vous entrainez à réaliser ces différents programmes, pensez à vider régulièrement le fichier 'fichier2.txt' avec un éditeur de textes tel NotePad.

Exercice

Afin de vérifier vos connaissances, je vous demande de réaliser le script qui insère en première ligne l'instant présent dans le fichier "fichier3.txt". Les données anciennes ne sont pas écrasées mais apparaissent à la suite.

C'est l'occasion de réviser la fonction date() et ses paramètres.
Correction en fin de chapitre.

Le contenu de "fichier3.txt"

Il est exactement 07:26:48 
 Il est exactement 07:04:27 
 Il est exactement 07:04:13 
 Il est exactement 07:03:50 
 Il est exactement 07:03:48 
 Il est exactement 07:03:46 
 Il est exactement 07:03:44 
 Il est exactement 07:03:30 
 Il est exactement 07:03:27

L'heure la plus récente apparait en tête. C'est donc l'ordre antéchronologique.

Des scripts plus professionnels

Si le programme tente d'ouvrir un fichier qui n'existe pas (ou n'existe plus) il y aura plantage ; il faut mieux afficher un message d'erreur q'un plantage.
Par ailleurs il faut concevoir un programme générique capable d'ouvrir et lire n'importe quel fichier texte. Il faut donc que l'utilisateur puisse saisir le nom du fichier via un formulaire.

Ecriture améliorée du premier programme de ce chapitre

...
<form action = "#"  method ='post'>
	<label>Nom du fichier : </label>	
	<input type = "text" required placeholder = "précisez bien .txt "  name ='nom'>
	<button type = 'submit'>Validez</button>
</form>
<h4>
<?php 
if(isset($_POST['nom']))
{	
	$nom_fichier = $_POST['nom']; 
	if (file_exists($nom_fichier))
	{
		echo '<p>La fonction file_get_content()</p>' ; 
		$contenu = file_get_contents($nom_fichier);
		echo $contenu; 
		echo '<hr>';
            			 
		...
		echo '<p>La fonction file()</p>' ; 
		$tableau = file($nom_fichier);
		print_r($tableau); 
		echo '<hr>'; 
		foreach ($tableau as $element)		
			{ echo "$element <br>" ;   }
		echo '<hr>';
	}
	else
		echo "Le fichier $nom_fichier que vous voulez ouvrir n'existe pas !" ; 
}
else echo "Renseignez le formulaire !";
?>
</h4>
...

Ce programme peut ouvrir n'importe quel fichier texte du répertoire courant.
Emploi de la fonction file_exists() qui retourne true si le nom de fichier passé en argument existe.

Le rendu

Testez le programme en saisissant d'abord un nom de fichier inconnu tel "bidon.txt" puis des noms de fichiers existants chez mon hébergeur tels que : "liste.txt", "fichier2.txt", "fichier3.txt".

Autres fonctions de manipulation des fichiers

Il existe une fonction qui permet de renommer un fichier : rename(ancienNom, nouveauNom).
Si le nouveau nom choisi est le nom d’un fichier qui existe déjà, alors ce fichier sera écrasé et remplacé par notre fichier renommé.

La fonction unlink() permet d’effacer le fichier passé en paramètre.
Cette fonction retourne un booléen : true en cas de succès et false en cas d'échec.

Le CHMOD sous Linux

Dès que vous allez héberger vos fichiers texte il va se poser un problème.
En effet le serveur de votre hébergeur de sites est en général sous LINUX (et non pas sous Windows). Or avec ce système d'exploitation le visiteur n'a pas forcément le droit d'écire dans un fichier texte.

Le CHMOD est un nombre à trois chiffres que l'on attribue à un fichier. Selon la valeur de ce nombre, Linux autorisera (ou pas) la modification d'un fichier.

Procédure

Démarrer le logiciel FTP, par exemple FileZila
connectez vous au serveur chez votre hébergeur
faites un clic droit sur l'un des fichiers texte hébergé

sélectionnez dans le menu contextuel "Droits d'accès au fichier".

Vous obtenez la boite de dialogue ci-dessous :

Dans la zone de texte légendée "valeur numérique" saisissez 777 pour que PHP puisse modifier le fichier texte en question.

Remarque importante

Par mesure de sécurité je n'autorise pas les visiteurs à écrire dans les différents fichiers texte (sauf 'fichier2.txt).

Correction de l'exercice

Le script

...
<h3>Insérer en debut de fichier3.txt</h3>
<h4>
<?php 
// pour générer l'heure de Paris
date_default_timezone_set('Europe/Paris');
echo '<pre>';
$ancien = file_get_contents('fichier3.txt');
echo $ancien ; 
echo '</pre>';
			
// insertion			
$heure_courante = date("h:i:s"); 
$insertion ="Il est exactement $heure_courante \n"; 

// nouveau contenu du fichier 		
$nouveau = $insertion . ' ' .$ancien ;
file_put_contents('fichier2.txt', $nouveau); 
?> 
</h4>
...

Commentaires du script

J'utilse la solution basée sur les méthodes file_get_contents & file_put_contents.
$heure_courante = date("h:i:s") : il est très facile en PHP de créer l'heure courante.
L'instant présent généré par la fonction date() est par défaut l'heure du lieu du serveur sauf si instruction : date_default_timezone_set('Europe/Paris')
$nouveau = $insertion . ' ' .$ancien : ansi la dernière insertion apparait en tête, devant les anciennes dates.

Traduction

Débuter en programmation web - sommaire

Initiation au HTML & CSS

Initiation à PHP & MYSQL

Débuter en programmation web - recherche

L'auteur : Patrick Darcheville

PHP et les fichiers texte

Lire la totalité d'un fichier texte

Un fichier de type 'text'

Programme pour lire ce fichier

Le code du document PHP

Le rendu

Lire une partie d'un fichier texte

Ouvrir un fichier texte

Mode d'ouverture d'un fichier

La fonction fread()

Le code du document PHP

Le rendu

Autre solution pour le script

La fonction gets()

Le script

Le rendu

Autre solution

La fonction fgetc()

Le script

Le rendu

Écrire dans un fichier

La fonction file_put_contents()

Le code

Le rendu

Ajouter dans un fichier texte

Première solution

Le code du document PHP - extrait

Capture d'écran du contenu de "fichier2.txt"

Solution plus orthodoxe

Consignes

Exercice

Le contenu de "fichier3.txt"

Des scripts plus professionnels

Ecriture améliorée du premier programme de ce chapitre

Le rendu

Autres fonctions de manipulation des fichiers

Le CHMOD sous Linux

Procédure

Remarque importante

Correction de l'exercice

Le script

Commentaires du script