1. class
  2. Soosyze
  3. \
  4. Components
  5. \
  6. Http
  7. \
  8. Stream

Stream

class Stream implements StreamInterface (View source)

Décrit un flux de données.

Properties

static protected array $modes Modes d'écriture et de lecture d'une ressource.

Methods

__construct($mixed = '')

Créer un flux de données à partir de données scalaire ou d'une ressource.

string
__toString()

Lit toutes les données du flux dans une chaîne.

static Stream
createStreamFromFile(type $filename, type $mode = 'r')

Créer un flux à partir d'un fichier.

close()

Ferme le flux de données et toutes les autres ressources.

resource|null
detach()

Sépare les ressources sous-jacentes du flux.

int|null
getSize()

Retourne la taille du flux.

int
tell()

Renvoie la position actuelle du pointeur de lecture/écriture du fichier.

bool
eof()

Renvoie true si le flux se trouve à la fin du flux.

bool|array
isSeekable()

Renvoie si la position du flux peut-être modifié.

void
seek(int $offset, int $whence = SEEK_SET)

Rechercher une position dans le flux.

void
rewind()

Replace le pointeur au début du flux.

bool
isWritable()

Renvoie si le flux est inscriptible ou non.

int
write(string $string)

Écrire des données dans le flux.

bool
isReadable()

Retourne si le flux est lisible ou non.

string
read(int $length)

Lit les données du flux jusqu'a la longueur d'octet renseignié.

string
getContents()

Renvoie le contenu restant.

array|mixed|null
getMetadata(string $key = null)

Obtenir des métadonnées de flux en tant que tableau associatif ou récupérer une clé spécifique.

bool
isAttached()

Si le flux de données est attaché.

Details

at line 74
__construct($mixed = '')

Créer un flux de données à partir de données scalaire ou d'une ressource.

Parameters

$mixed bool|float|int|object|ressource|string|null

Exceptions

InvalidArgumentException Le type de données n'est pas pris en charge par flux de données.

See also

http://php.net/manual/fr/wrappers.php.php

at line 96
string __toString()

Lit toutes les données du flux dans une chaîne.

Return Value

string

See also

http://php.net/manual/fr/language.oop5.magic.php#object.tostring

at line 117
static Stream createStreamFromFile(type $filename, type $mode = 'r')

Créer un flux à partir d'un fichier.

Parameters

type $filename Nom du fichier.
type $mode Mode de lecture du fichier.

Return Value

Stream

Exceptions

InvalidArgumentException Le mode de lecture n'est pas valide.
RuntimeException Le fichier ne peut pas être ouvert.

at line 135
close()

Ferme le flux de données et toutes les autres ressources.

at line 150
resource|null detach()

Sépare les ressources sous-jacentes du flux.

Après que le flux a été détaché, le flux est dans un état inutilisable.

Return Value

resource|null Flux PHP sous-jacent, le cas échéant

at line 164
int|null getSize()

Retourne la taille du flux.

Return Value

int|null Renvoie la taille en octets si elle est connue, ou null si elle est inconne.

at line 182
int tell()

Renvoie la position actuelle du pointeur de lecture/écriture du fichier.

Return Value

int Position du pointeur de fichier

Exceptions

RuntimeException Une erreur est survenue.

at line 198
bool eof()

Renvoie true si le flux se trouve à la fin du flux.

Return Value

bool

Exceptions

RuntimeException Une erreur est survenue.

at line 210
bool|array isSeekable()

Renvoie si la position du flux peut-être modifié.

Return Value

bool|array

at line 231
void seek(int $offset, int $whence = SEEK_SET)

Rechercher une position dans le flux.

Parameters

int $offset Décalage de flux.
int $whence Spécifie comment la position du curseur sera calculée basé sur le décalage de recherche.

Return Value

void

Exceptions

RuntimeException Une erreur est survenue.

at line 245
void rewind()

Replace le pointeur au début du flux.

Return Value

void

Exceptions

RuntimeException Une erreur est survenue.

at line 258
bool isWritable()

Renvoie si le flux est inscriptible ou non.

Return Value

bool

at line 273
int write(string $string)

Écrire des données dans le flux.

Parameters

string $string La chaîne à écrire.

Return Value

int Renvoie le nombre d'octets écrits dans le flux.

Exceptions

RuntimeException Une erreur est survenue.

at line 288
bool isReadable()

Retourne si le flux est lisible ou non.

Return Value

bool

at line 306
string read(int $length)

Lit les données du flux jusqu'a la longueur d'octet renseignié.

Si le flux est inférieur à la longueur donnée il renverra moins d'octet.

Parameters

int $length Longueur d'octet.

Return Value

string Renvoie les données lues dans le flux ou une chaîne vide si aucun octet n'est disponible.

Exceptions

RuntimeException La valeur d'octet doit être un nombre entier positif.
RuntimeException Une erreur est survenue.

at line 328
string getContents()

Renvoie le contenu restant.

Return Value

string

Exceptions

RuntimeException Une erreur c'est produit pendant la lecture du flux.

at line 350
array|mixed|null getMetadata(string $key = null)

Obtenir des métadonnées de flux en tant que tableau associatif ou récupérer une clé spécifique.

Les clés retournées sont identiques aux clés retournées par PHP.

Parameters

string $key Métadonnées spécifiques à récupérer.

Return Value

array|mixed|null Renvoie un tableau associatif si aucune clé n'est renségné. renvoie une valeur de clé spécifique si une clé est fournie et trouvé, ou null si la clé n'est pas trouvée.

at line 366
protected bool isAttached()

Si le flux de données est attaché.

Return Value

bool