Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe RelativeStream
+ Graphe d'héritage de RelativeStream:

Fonctions membres publiques

 __construct (StreamInterface $decoratedStream, ?int $offset)
 
 __toString ()
 
 close ()
 
 detach ()
 
 getSize ()
 
 tell ()
 
 eof ()
 
 isSeekable ()
 
 seek ($offset, $whence=SEEK_SET)
 
 rewind ()
 
 isWritable ()
 
 write ($string)
 
 isReadable ()
 
 read ($length)
 
 getContents ()
 
 getMetadata ($key=null)
 

Attributs privés

 $decoratedStream
 
 $offset
 

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( StreamInterface  $decoratedStream,
?int  $offset 
)

Class constructor

Paramètres
StreamInterface$decoratedStream
int$offset

Références RelativeStream\$decoratedStream, RelativeStream\$offset, et Joomla\Database\Query\offset().

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 RelativeStream\getContents(), RelativeStream\isSeekable(), et RelativeStream\seek().

◆ close()

close ( )

{Closes the stream and any underlying resources.

Renvoie
void
}

Implémente StreamInterface.

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

◆ 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érences RelativeStream\tell().

Référencé par RelativeStream\__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.

◆ 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 RelativeStream\$offset.

◆ isReadable()

isReadable ( )

{Returns whether or not the stream is readable.

Renvoie
bool
}

Implémente StreamInterface.

◆ isSeekable()

isSeekable ( )

{Returns whether or not the stream is seekable.

Renvoie
bool
}

Implémente StreamInterface.

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

◆ isWritable()

isWritable ( )

{Returns whether or not the stream is writable.

Renvoie
bool
}

Implémente StreamInterface.

◆ read()

read (   $length)

{Read data from the stream.

Paramètres
int$lengthRead 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 RelativeStream\tell().

◆ 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 RelativeStream\seek().

◆ seek()

◆ 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 RelativeStream\$offset.

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

◆ write()

write (   $string)

{Write data to the stream.

Paramètres
string$stringThe string that is to be written.
Renvoie
int Returns the number of bytes written to the stream.
Exceptions
}

Implémente StreamInterface.

Références RelativeStream\tell().

Documentation des champs

◆ $decoratedStream

$decoratedStream
private

Référencé par RelativeStream\__construct().

◆ $offset


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