Référence de la classe Stream

Graphe d'héritage de Stream:

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

Attributs protégés
	$resource
	$stream

Fonctions membres privées
	setStream ($stream, string $mode='r')
	isValidStreamResourceType ($resource)

Attributs privés
const	ALLOWED_STREAM_RESOURCE_TYPES = ['gd', 'stream']

Description détaillée

Implementation of PSR HTTP streams

Documentation des constructeurs et destructeur

__construct()

__construct	(		$stream,
		string	$mode = 'r'
	)

Paramètres

string | resource	$stream
string	$mode	Mode with which to open stream

Exceptions

Exception

Références $mode, Stream\$stream, et Stream\setStream().

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émente StreamInterface.

Références Stream\getContents(), Stream\isReadable(), Stream\isSeekable(), et Stream\rewind().

attach()

attach	(		$resource,
		string	$mode = 'r'
	)

Attach a new stream/resource to the instance.

Paramètres

string | resource	$resource
string	$mode

Exceptions

Exception

Références $mode, Stream\$resource, et Stream\setStream().

close()

close

(

)

{Closes the stream and any underlying resources.

Renvoie

void

}

Implémente StreamInterface.

Références Stream\$resource, et Stream\detach().

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 Stream\$resource, 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.

Référencé par PhpInputStream\getContents(), et PhpInputStream\read().

getContents()

getContents

(

)

{Returns the remaining contents in a string

Renvoie

string

Exceptions

}

Implémente StreamInterface.

Références $result, UnreadableStreamException\dueToConfiguration(), UnreadableStreamException\dueToPhpError(), et Stream\isReadable().

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

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émente StreamInterface.

Références $key, et null.

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 null.

isReadable()

isReadable

(

)

{Returns whether or not the stream is readable.

Renvoie

bool

}

Implémente StreamInterface.

Références $mode.

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

isSeekable()

isSeekable

(

)

{Returns whether or not the stream is seekable.

Renvoie

bool

}

Implémente StreamInterface.

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

isValidStreamResourceType()

isValidStreamResourceType (   $resource )

private

Determine if a resource is one of the resource types allowed to instantiate a Stream

Paramètres

resource

$resource

Stream resource.

Références Stream\$resource.

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

isWritable()

isWritable

(

)

{Returns whether or not the stream is writable.

Renvoie

bool

}

Implémente StreamInterface.

Références $mode.

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

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, UnreadableStreamException\dueToConfiguration(), UnreadableStreamException\dueToMissingResource(), UnreadableStreamException\dueToPhpError(), et Stream\isReadable().

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().

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

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, $result, UnseekableStreamException\dueToConfiguration(), UnseekableStreamException\dueToMissingResource(), UnseekableStreamException\dueToPhpError(), et Stream\isSeekable().

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

setStream()

setStream (   $stream, string  $mode = 'r'  )

private

Set the internal stream resource.

Paramètres

string | resource	$stream	String stream target or stream resource.
string	$mode	Resource mode for stream target.

Exceptions

Exception

Références $mode, Stream\$resource, Stream\$stream, Stream\isValidStreamResourceType(), et null.

Référencé par Stream\__construct(), et Stream\attach().

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, UntellableStreamException\dueToMissingResource(), et UntellableStreamException\dueToPhpError().

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, UnwritableStreamException\dueToConfiguration(), UnwritableStreamException\dueToMissingResource(), UnwritableStreamException\dueToPhpError(), et Stream\isWritable().

Documentation des champs

$resource

$resource

protected

Référencé par Stream\attach(), Stream\close(), Stream\detach(), Stream\isValidStreamResourceType(), et Stream\setStream().

$stream

$stream

protected

Référencé par PhpInputStream\__construct(), Stream\__construct(), et Stream\setStream().

ALLOWED_STREAM_RESOURCE_TYPES

const ALLOWED_STREAM_RESOURCE_TYPES = ['gd', 'stream']

private

A list of allowed stream resource types that are allowed to instantiate a Stream

---

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

• vendor/laminas/laminas-diactoros/src/Stream.php