Référence de la classe Stream

Graphe d'héritage de Stream:

Fonctions membres publiques
	__destruct ()
	__toString ()
	close ()
	detach ()
	getSize ()
	tell ()
	eof ()
	isSeekable ()
	seek ($offset, $whence=\SEEK_SET)
	rewind ()
	isWritable ()
	write ($string)
	isReadable ()
	read ($length)
	getContents ()
	getMetadata ($key=null)

Fonctions membres publiques statiques
static	create ($body='')

Fonctions membres privées
const	__construct ()
	getUri ()

Attributs privés
	$stream
	$seekable
	$readable
	$writable
	$uri
	$size
const	READ_WRITE_HASH

Description détaillée

Auteur

Michael Dowling and contributors to guzzlehttp/psr7

Tobias Nyholm tobia.nosp@m.s.ny.nosp@m.holm@.nosp@m.gmai.nosp@m.l.com

Martijn van der Ven marti.nosp@m.jn@v.nosp@m.ander.nosp@m.ven..nosp@m.se

This class should never be extended. See https://github.com/Nyholm/psr7/blob/master/doc/final.md

Documentation des constructeurs et destructeur

__construct()

const __construct ( )

private

__destruct()

__destruct

(

)

Closes the stream when the destructed.

Références Stream\close().

Documentation des fonctions membres

__toString()

__toString

(

)

Renvoie

string

Implémente StreamInterface.

Références $errorHandler, Stream\getContents(), Stream\isSeekable(), null, et Stream\seek().

close()

close

(

)

Closes the stream and any underlying resources.

Renvoie

void

Implémente StreamInterface.

Références Stream\detach().

Référencé par Stream\__destruct().

create()

static create (   $body = '' )

static

Creates a new PSR-7 stream.

Paramètres

string | resource | StreamInterface

$body

Exceptions

Référencé par Request\__construct(), Response\__construct(), ServerRequest\__construct(), UploadedFile\__construct(), HttplugFactory\createStream(), Psr17Factory\createStream(), Psr17Factory\createStreamFromFile(), Psr17Factory\createStreamFromResource(), Nyholm\Psr7\getBody(), UploadedFile\getStream(), et UploadedFile\moveTo().

detach()

detach

(

)

Separates any underlying resources from the stream.

After the stream has been detached, the stream is in an unusable state.

Renvoie

resource|null Underlying PHP stream, if any

Implémente StreamInterface.

Références $result, Stream\$stream, et null.

Référencé par Stream\close().

eof()

eof

(

)

Returns true if the stream is at the end of the stream.

Renvoie

bool

Implémente StreamInterface.

getContents()

getContents

(

)

Returns the remaining contents in a string

Renvoie

string

Exceptions

Implémente StreamInterface.

Référencé par Stream\__toString().

getMetadata()

getMetadata

(

$key = null

)

Renvoie

mixed

Implémente StreamInterface.

Références $key, et null.

Référencé par Stream\getUri().

getSize()

getSize

(

)

Get the size of the stream if known.

Renvoie

int|null Returns the size in bytes if known, or null if unknown.

Implémente StreamInterface.

Références Stream\$size, Stream\$uri, Stream\getUri(), et null.

getUri()

getUri ( )

private

Références Stream\$uri, et Stream\getMetadata().

Référencé par Stream\getSize().

isReadable()

isReadable

(

)

Returns whether or not the stream is readable.

Renvoie

bool

Implémente StreamInterface.

Références Stream\$readable.

isSeekable()

isSeekable

(

)

Returns whether or not the stream is seekable.

Renvoie

bool

Implémente StreamInterface.

Références Stream\$seekable.

Référencé par Stream\__toString().

isWritable()

isWritable

(

)

Returns whether or not the stream is writable.

Renvoie

bool

Implémente StreamInterface.

Références Stream\$writable.

read()

read

(

$length

)

Read data from the stream.

Paramètres

int

$length

Read up to $length bytes from the object and return them. Fewer than $length bytes may be returned if underlying stream call returns fewer bytes.

Renvoie

string Returns the data read from the stream, or an empty string if no bytes are available.

Exceptions

Implémente StreamInterface.

Références $result.

rewind()

rewind

(

)

Seek to the beginning of the stream.

If the stream is not seekable, this method will raise an exception; otherwise, it will perform a seek(0).

Voir également

seek() on failure.

Implémente StreamInterface.

Références Stream\seek().

seek()

seek	(		$offset,
			$whence = \SEEK_SET
	)

Seek to a position in the stream.

int $offset Stream offset int $whence Specifies how the cursor position will be calculated based on the seek offset. Valid values are identical to the built-in PHP $whence values for fseek(). SEEK_SET: Set position equal to offset bytes SEEK_CUR: Set position to current location plus offset SEEK_END: Set position to end-of-stream plus offset. on failure.

Implémente StreamInterface.

Références Joomla\Database\Query\$offset.

Référencé par Stream\__toString(), et Stream\rewind().

tell()

tell

(

)

Returns the current position of the file read/write pointer

Renvoie

int Position of the file pointer

Exceptions

Implémente StreamInterface.

Références $result.

write()

write

(

$string

)

Write data to the stream.

Paramètres

string

$string

The string that is to be written.

Renvoie

int Returns the number of bytes written to the stream.

Exceptions

Implémente StreamInterface.

Références $result, et null.

Documentation des champs

$readable

$readable

private

Référencé par Stream\isReadable().

$seekable

$seekable

private

Référencé par Stream\isSeekable().

$size

$size

private

Référencé par Stream\getSize().

$stream

$stream

private

Référencé par Stream\detach().

$uri

$uri

private

Référencé par Stream\getSize(), et Stream\getUri().

$writable

$writable

private

Référencé par Stream\isWritable().

READ_WRITE_HASH

const READ_WRITE_HASH

private

Valeur initiale :

= [
        'read' => [
            'r' => true

---

La documentation de cette classe a été générée à partir du fichier suivant :

• vendor/nyholm/psr7/src/Stream.php