Référence de l'interface StreamInterface

Graphe d'héritage de StreamInterface:

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

Description détaillée

Describes a data stream.

Typically, an instance will wrap a PHP stream; this interface provides a wrapper around the most common operations, including serialization of the entire stream to a string.

Documentation des fonctions membres

__toString()

__toString

(

)

Reads all data from the stream into a string, from the beginning to end.

This method MUST attempt to seek to the beginning of the stream before reading data and read the stream until the end is reached.

Warning: This could attempt to load a large amount of data into memory.

This method MUST NOT raise an exception in order to conform with PHP's string casting operations.

Voir également

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

Renvoie

string

Implémenté dans Stream, Stream, RelativeStream, CallbackStream, et PhpInputStream.

close()

close

(

)

Closes the stream and any underlying resources.

Renvoie

void

Implémenté dans Stream, Stream, RelativeStream, et CallbackStream.

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émenté dans Stream, Stream, RelativeStream, et CallbackStream.

eof()

eof

(

)

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

Renvoie

bool

Implémenté dans Stream, Stream, RelativeStream, et CallbackStream.

getContents()

getContents

(

)

Returns the remaining contents in a string

Renvoie

string

Exceptions

Implémenté dans Stream, Stream, RelativeStream, et CallbackStream.

getMetadata()

getMetadata

(

$key = null

)

Get stream metadata as an associative array or retrieve a specific key.

The keys returned are identical to the keys returned from PHP's stream_get_meta_data() function.

string $key Specific metadata to retrieve. array|mixed|null Returns an associative array if no key is provided. Returns a specific key value if a key is provided and the value is found, or null if the key is not found.

Implémenté dans Stream, Stream, RelativeStream, et CallbackStream.

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émenté dans Stream, Stream, RelativeStream, et CallbackStream.

isReadable()

isReadable

(

)

Returns whether or not the stream is readable.

Renvoie

bool

Implémenté dans Stream, Stream, RelativeStream, et CallbackStream.

isSeekable()

isSeekable

(

)

Returns whether or not the stream is seekable.

Renvoie

bool

Implémenté dans Stream, Stream, RelativeStream, et CallbackStream.

isWritable()

isWritable

(

)

Returns whether or not the stream is writable.

Renvoie

bool

Implémenté dans Stream, Stream, RelativeStream, CallbackStream, et PhpInputStream.

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émenté dans Stream, Stream, RelativeStream, CallbackStream, et PhpInputStream.

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émenté dans Stream, Stream, RelativeStream, et CallbackStream.

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émenté dans Stream, Stream, RelativeStream, et CallbackStream.

tell()

tell

(

)

Returns the current position of the file read/write pointer

Renvoie

int Position of the file pointer

Exceptions

Implémenté dans Stream, Stream, RelativeStream, et CallbackStream.

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émenté dans Stream, Stream, RelativeStream, et CallbackStream.

---

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

• StreamInterface.php