Référence de la classe StringWrapper

Fonctions membres publiques
	stream_open ($path, $mode, $options, &$openedPath)
	stream_stat ()
	url_stat ($path, $flags=0)
	stream_read ($count)
	stream_write ($data)
	stream_tell ()
	stream_eof ()
	stream_seek ($offset, $whence)
	stream_flush ()

Attributs protégés
	$currentString
	$path
	$mode
	$options
	$openedPath
	$pos
	$len
	$stat

Description détaillée

String Stream Wrapper

This class allows you to use a PHP string in the same way that you would normally use a regular stream wrapper

Depuis

1.3.0

Documentation des fonctions membres

stream_eof()

stream_eof

(

)

End of field check

Renvoie

boolean True if at end of field.

Depuis

1.3.0

stream_flush()

stream_flush

(

)

Stream flush, always returns true.

Renvoie

boolean

Depuis

1.3.0

Note

Data storage is not supported

stream_open()

stream_open	(		$path,
			$mode,
			$options,
		&	$openedPath
	)

Method to open a file or URL.

Paramètres

string	$path	The stream path.
string	$mode	Not used.
integer	$options	Not used.
string	$openedPath	Not used.

Renvoie

boolean

Depuis

1.3.0

Références StringWrapper\$path, et StringWrapper\url_stat().

stream_read()

stream_read

(

$count

)

Method to read a given number of bytes starting at the current position and moving to the end of the string defined by the current position plus the given number.

Paramètres

integer

$count

Bytes of data from the current position should be returned.

Renvoie

string

1.3.0

Références $count, et $result.

stream_seek()

stream_seek	(		$offset,
			$whence
	)

Stream offset

Paramètres

integer	$offset	The starting offset.
integer	$whence	SEEK_SET, SEEK_CUR, SEEK_END

Renvoie

boolean True on success.

Depuis

1.3.0

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

stream_stat()

stream_stat

(

)

Method to retrieve information from a file resource

Renvoie

array

1.3.0

Références StringWrapper\$stat.

stream_tell()

stream_tell

(

)

Method to get the current position

Renvoie

integer The position

Depuis

1.3.0

Références StringWrapper\$pos.

stream_write()

stream_write

(

$data

)

Stream write, always returning false.

Paramètres

string

$data

The data to write.

Renvoie

boolean

Depuis

1.3.0

Note

Updating the string is not supported.

url_stat()

url_stat	(		$path,
			$flags = 0
	)

Method to retrieve information about a file.

Paramètres

string	$path	File path or URL to stat
integer	$flags	Additional flags set by the streams API

Renvoie

array

1.3.0

Références $now, StringWrapper\$path, et StringWrapper\$stat.

Référencé par StringWrapper\stream_open().

Documentation des champs

$currentString

$currentString

protected

$len

$len

protected

$mode

$mode

protected

$openedPath

$openedPath

protected

$options

$options

protected

$path

$path

protected

Référencé par StringWrapper\stream_open(), et StringWrapper\url_stat().

$pos

$pos

protected

Référencé par StringWrapper\stream_tell().

$stat

$stat

protected

Référencé par StringWrapper\stream_stat(), et StringWrapper\url_stat().

---

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

• StringWrapper.php