stream_filter_register

(PHP 5)

stream_filter_registerEnregistre un filtre de flux

Description

bool stream_filter_register ( string $filtername , string $classname )

stream_filter_register() vous permet d'implémenter votre propre filtre de flux, à utiliser avec les fonctions d'accès aux données externes (comme fopen(), fread(), etc.).

Liste de paramètres

filtername

Le nom du filtre à enregistrer.

classname

Pour créer une classe de filtre, vous devez définir une classe qui étend la classe php_user_fitler. Lorsque vous réalisez des opérations de lecture et d'écriture dans le flux auquel votre filtre est attaché, PHP passera les données à travers votre filtre (et tous les autres filtres attachés), de façon à ce que les données soient modifiées tel que désiré. Vous devez implémenter les méthodes tel que décrit dans php_user_filter, sous peine de comportements indéfinis.

Valeurs de retour

Cette fonction retourne TRUE en cas de succès ou FALSE si une erreur survient.

stream_filter_register() doit toujours retourner FALSE si le paramètre filtername est déjà défini.

Exemples

Exemple #1 Filtre sur les lettres majuscules sur le flux foo-bar.txt

<?php

/* Définition de la classe */
class strtoupper_filter extends php_user_filter {
  function filter($in, $out, &$consumed, $closing) 
  {
	while ($bucket = stream_bucket_make_writeable($in)) {
	  $bucket->data = strtoupper($bucket->data);
	  $consumed += $bucket->datalen;
	  stream_bucket_append($out, $bucket);
	}
	return PSFS_PASS_ON;
  }
} 

/* Enregistrement de notre filtre avec PHP */
stream_filter_register("strtoupper", "strtoupper_filter")
	or die("Erreur lors de l'enregistrement du filtre");

$fp = fopen("foo-bar.txt", "w");

/* Attachement du filtre enregistré au flux que l'on vient d'ouvrir */
stream_filter_append($fp, "strtoupper");

fwrite($fp, "Ligne1\n");
fwrite($fp, "Mot - 2\n");
fwrite($fp, "Facile comme 123\n");

fclose($fp);

/* Lecture du contenu
 */
readfile("foo-bar.txt");

?>
<?php

/* Définition de la classe*/
class string_filter extends php_user_filter {
  var $mode;

  function filter($in, $out, &$consumed, $closing) 
  {
	while ($bucket = stream_bucket_make_writeable($in)) {
	  if ($this->mode == 1) {
		$bucket->data = strtoupper($bucket->data);
	  } elseif ($this->mode == 0) {
		$bucket->data = strtolower($bucket->data);
	  }

	  $consumed += $bucket->datalen;
	  stream_bucket_append($out, $bucket);
	}
	return PSFS_PASS_ON;
  }

  function onCreate() 
  {
	if ($this->filtername == 'str.toupper') {
	  $this->mode = 1;
	} elseif ($this->filtername == 'str.tolower') {
	  $this->mode = 0;
	} else {
	  /* Quelques autres filtres str.* sont demandés,
		  traitement de l'erreur avec PHP */
	  return false;
	}

	return true;
  }
} 

/* Enregistrement de notre filtre avec PHP */
stream_filter_register("str.*", "string_filter")
	or die("Failed to register filter");

$fp = fopen("foo-bar.txt", "w");

/* Attachement du filtre enregistré au flux que l'on vient d'ouvrir
	Nous pouvons alternativement passer à str.tolower ici */
stream_filter_append($fp, "str.toupper");

fwrite($fp, "Ligne1\n");
fwrite($fp, "Mot - 2\n");
fwrite($fp, "Facile comme 123\n");

fclose($fp);

/* Lecture du contenu
 */
readfile("foo-bar.txt");

?>

L'exemple ci-dessus va afficher :

LINE1
MOT - 2
FACILE COMME 123

Voir aussi

LoadingChargement en cours