Flux

Introduction

Les flux sont une méthode de généralisation des fichiers, sockets, connexions réseau, données compressées et autres opérations du même type, qui partagent des opérations communes. Dans sa définition la plus simple, un stream est une resource qui présente des capacités de flux : c'est-à-dire que ces objets peuvent être lus ou recevoir des écritures de manière linéaire, et disposent aussi de moyens d'accéder à une position arbitraire dans le flux.

Un wrapper est une fonction qui indique comment le flux se comporte spécifiquement. C'est le cas du gestionnaire http, qui sait comment traduire une URL en une requête HTTP/1.0 sur un serveur distant. Il existe de nombreux gestionnaires intégrés à PHP par défaut (voir Liste des protocoles et des gestionnaires supportés), et, de plus, des gestionnaires spécifiques peuvent être ajoutés dans les scripts PHP avec la fonction stream_register_wrapper(), ou bien directement par une autre extension. Grâce à la souplesse des gestionnaires qui peuvent être ajoutés à PHP, il n'y a pas de limites aux possibilités offertes. Pour connaître la liste des gestionnaires actuellement enregistrés, utiliser la fonction stream_get_wrappers().

Un flux est référencé comme : scheme://target

scheme (string) - Le nom du gestionnaire à utiliser. Par exemple, file, http, https, ftp, ftps, compress.zlib, compress.bz2 et php. Voir Liste des protocoles et des gestionnaires supportés pour une liste complète des gestionnaires enregistrés de PHP. Si aucun gestionnaire n'est spécifié, la fonction par défaut est utilisée (typiquement, file://).
target - Dépend du gestionnaire utilisé. Pour les flux relatifs aux systèmes de fichiers, c'est typiquement un chemin et un nom de fichier du fichier désiré. Pour les flux relatifs aux réseaux, c'est typiquement le nom d'hôte, souvent avec un chemin apposé. Voir aussi Liste des protocoles et des gestionnaires supportés pour une description des cibles des flux intégrés.

Installation/Configuration
- Classes Stream
Constantes pré-définies
Filtres de flux
Contextes de flux
Erreurs de flux
Exemples
- Exemple de classe enregistrée comme gestionnaire de flux
php_user_filter — La classe php_user_filter
- php_user_filter::filter — Appelé lors de l'application d'un filtre
- php_user_filter::onClose — Appelé lors de la fermeture du filtre
- php_user_filter::onCreate — Appelé lors de la création du filtre
streamWrapper — La classe streamWrapper
- streamWrapper::__construct — Construit un nouveau gestionnaire de flux
- streamWrapper::__destruct — Détruit un gestionnaire de flux existant
- streamWrapper::dir_closedir — Ferme une ressource de dossier
- streamWrapper::dir_opendir — Ouvre un dossier en lecture
- streamWrapper::dir_readdir — Lit un fichier dans un dossier
- streamWrapper::dir_rewinddir — Remet au début une ressource de dossier
- streamWrapper::mkdir — Crée un dossier
- streamWrapper::rename — Renomme un fichier ou un dossier
- streamWrapper::rmdir — Supprime un dossier
- streamWrapper::stream_cast — Lit la ressource sous-jacente de flux
- streamWrapper::stream_close — Ferme une ressource de flux
- streamWrapper::stream_eof — Teste la fin de fichier sur un pointeur de fichier
- streamWrapper::stream_flush — Expédie le contenu
- streamWrapper::stream_lock — Verrouillage logique de fichiers
- streamWrapper::stream_metadata — Change les metadata du flux
- streamWrapper::stream_open — Ouvre un fichier ou une URL
- streamWrapper::stream_read — Lit dans le flux
- streamWrapper::stream_seek — Place le pointeur de flux à une position
- streamWrapper::stream_set_option — Change les options du flux
- streamWrapper::stream_stat — Lit les informations sur une ressource de fichier
- streamWrapper::stream_tell — Lit la position courante dans un flux
- streamWrapper::stream_truncate — Tronque un flux
- streamWrapper::stream_write — Écrit dans un flux
- streamWrapper::unlink — Efface un fichier
- streamWrapper::url_stat — Lit les informations sur un fichier
Fonctions sur les flux
- stream_bucket_append — Ajoute un compartiment au corps
- stream_bucket_make_writeable — Retourne un objet de compartiment depuis le corps pour des opérations sur celui-ci
- stream_bucket_new — Crée un nouveau compartiment pour l'utiliser sur le flux courant
- stream_bucket_prepend — Ajout initial d'un bucket dans une brigade
- stream_context_create — Crée un contexte de flux
- stream_context_get_default — Lit le contexte par défaut des flux
- stream_context_get_options — Lit la valeur des options pour un flux/gestionnaire/contexte
- stream_context_get_params — Lit les paramètres d'un contexte
- stream_context_set_default — Configure le contexte par défaut des flux
- stream_context_set_option — Configure une option pour un flux/gestionnaire/contexte
- stream_context_set_options — Définit les options sur le contexte spécifié
- stream_context_set_params — Configure les paramètres pour un flux/gestionnaire/contexte
- stream_copy_to_stream — Copie des données depuis un flux vers un autre
- stream_filter_append — Attache un filtre à un flux en fin de liste
- stream_filter_prepend — Attache un filtre à un flux en début de liste
- stream_filter_register — Enregistre un filtre de flux
- stream_filter_remove — Retire un filtre d'un flux
- stream_get_contents — Lit tout un flux dans une chaîne
- stream_get_filters — Liste les filtres enregistrés
- stream_get_line — Lit une ligne dans un flux
- stream_get_meta_data — Lit les en-têtes et données méta des flux
- stream_get_transports — Liste les gestionnaires de transports de sockets disponibles
- stream_get_wrappers — Liste les gestionnaires de flux
- stream_is_local — Vérifie si un flux est local
- stream_isatty — Vérifie si un flux est un TTY
- stream_notification_callback — Une fonction de rappel pour le paramètre de contexte notification
- stream_register_wrapper — Alias de stream_wrapper_register
- stream_resolve_include_path — Résout un nom de fichier suivant les règles du chemin d'inclusion
- stream_select — Surveille la modification d'un ou plusieurs flux
- stream_set_blocking — Configure le mode bloquant d'un flux
- stream_set_chunk_size — Change la taille du segment du flux
- stream_set_read_buffer — Configure le buffer de lecture d'un flux
- stream_set_timeout — Configure la durée d'expiration d'un flux
- stream_set_write_buffer — Configure le buffer d'écriture d'un flux
- stream_socket_accept — Accepte une connexion sur un socket créé par stream_socket_server
- stream_socket_client — Ouvre une connexion socket Internet ou Unix
- stream_socket_enable_crypto — Active ou non le chiffrement, pour un socket déjà connecté
- stream_socket_get_name — Lit le nom de la socket locale ou distante
- stream_socket_pair — Crée une paire de sockets connectées et indissociables
- stream_socket_recvfrom — Lit des données depuis un socket, connecté ou pas
- stream_socket_sendto — Envoie un message au socket, connecté ou pas
- stream_socket_server — Crée un socket serveur Unix ou Internet
- stream_socket_shutdown — Arrête une connexion full-duplex
- stream_supports_lock — Indique si le flux supporte les verrous
- stream_wrapper_register — Enregistre un gestionnaire d'URL
- stream_wrapper_restore — Restaure un gestionnaire d'URL supprimé
- stream_wrapper_unregister — Supprime un gestionnaire d'URL