Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe BufferStreamHandler

Fonctions membres publiques

 stream_open ($path, $mode, $options, &$opened_path)
 
 stream_read ($count)
 
 stream_write ($data)
 
 stream_tell ()
 
 stream_eof ()
 
 stream_seek ($offset, $whence)
 

Fonctions membres publiques statiques

static stream_register ()
 

Champs de données

 $position = 0
 
 $name = null
 
 $buffers = array()
 

Fonctions membres protégées

 seek_set ($offset)
 
 seek_cur ($offset)
 
 seek_end ($offset)
 

Attributs privés statiques

static $registered = false
 

Description détaillée

Generic Buffer stream handler

This class provides a generic buffer stream. It can be used to store/retrieve/manipulate string buffers with the standard PHP filesystem I/O methods.

Depuis
11.1

Documentation des fonctions membres

◆ seek_cur()

seek_cur (   $offset)
protected

Adds the offset to current position

Paramètres
integer$offsetThe offset in bytes
Renvoie
bool

Références $offset.

◆ seek_end()

seek_end (   $offset)
protected

Sets the position to the end of the current buffer + offset

Paramètres
integer$offsetThe offset in bytes
Renvoie
bool

Références $offset, et name.

◆ seek_set()

seek_set (   $offset)
protected

Set the position to the offset

Paramètres
integer$offsetThe offset in bytes
Renvoie
bool

Références $offset, et name.

◆ stream_eof()

stream_eof ( )

Function to test for end of file pointer

Renvoie
boolean True if the pointer is at the end of the stream
Voir également
streamWrapper::stream_eof
Depuis
11.1

Références name.

◆ stream_open()

stream_open (   $path,
  $mode,
  $options,
$opened_path 
)

Function to open file or url

Paramètres
string$pathThe URL that was passed
string$modeMode used to open the file
Voir également
fopen
Paramètres
integer$optionsFlags used by the API, may be STREAM_USE_PATH and STREAM_REPORT_ERRORS
string&$opened_pathFull path of the resource. Used with STREAN_USE_PATH option
Renvoie
boolean
Depuis
11.1
Voir également
streamWrapper::stream_open

Références $name, $path, $url, name, et null.

◆ stream_read()

stream_read (   $count)

Read stream

Paramètres
integer$countHow many bytes of data from the current position should be returned.
Renvoie
mixed The data from the stream up to the specified number of bytes (all data if the total number of bytes in the stream is less than $count. Null if the stream is empty.
Voir également
streamWrapper::stream_read
Depuis
11.1

Références $count, et name.

◆ stream_register()

static stream_register ( )
static

Function to register the stream wrapper

Renvoie
void
Depuis
3.8.2

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

◆ stream_seek()

stream_seek (   $offset,
  $whence 
)

The read write position updates in response to $offset and $whence

Paramètres
integer$offsetThe offset in bytes
integer$whencePosition the offset is added to Options are SEEK_SET, SEEK_CUR, and SEEK_END
Renvoie
boolean True if updated
Voir également
streamWrapper::stream_seek
Depuis
11.1

Références $offset.

◆ stream_tell()

stream_tell ( )

Function to get the current position of the stream

Renvoie
integer
Voir également
streamWrapper::stream_tell
Depuis
11.1

Références $position.

◆ stream_write()

stream_write (   $data)

Write stream

Paramètres
string$dataThe data to write to the stream.
Renvoie
integer
Voir également
streamWrapper::stream_write
Depuis
11.1

Références $data, $name, et name.

Documentation des champs

◆ $buffers

$buffers = array()

◆ $name

$name = null

◆ $position

$position = 0

◆ $registered

$registered = false
staticprivate

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