Docs For Class JStreamString

Description

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

since: 11.1

Located in /libraries/joomla/filesystem/streams/string.php (line 24)

Variable Summary

string $currentString

string $len

string $mode

string $openedPath

string $options

string $path

integer $pos

array $stat

Method Summary

boolean stream_eof ()

boolean stream_flush ()

boolean stream_open (string $path, string $mode, integer $options, string &$opened_path)

void stream_read (integer $count)

boolean stream_seek (integer $offset, integer $whence)

array stream_stat ()

integer stream_tell ()

boolean stream_write (string $data)

array url_stat (string $path, [integer $flags = 0])

Variables

string $currentString (line 32)

The current string

since: 12.1
access: protected

string $len (line 85)

Length of the string

since: 12.1
access: protected

string $mode (line 50)

The mode

since: 12.1
access: protected

string $openedPath (line 68)

Enter description here ...

since: 12.1
access: protected

string $options (line 59)

Enter description here ...

since: 12.1
access: protected

string $path (line 41)

The path

since: 12.1
access: protected

integer $pos (line 76)

Current position

since: 12.1
access: protected

array $stat (line 95)

Statistics for a file

see: http://us.php.net/manual/en/function.stat.php
since: 12.1
access: protected

Methods

stream_eof (line 229)

End of field check

return: True if at end of field.
since: 11.1
access: public

boolean stream_eof ()

stream_flush (line 291)

Stream flush, always returns true.

since: 11.1
access: public

boolean stream_flush ()

stream_open (line 109)

Method to open a file or URL.

since: 11.1
access: public

boolean stream_open (string $path, string $mode, integer $options, string &$opened_path)

string $path: The stream path.
string $mode: Not used.
integer $options: Not used.
string &$opened_path: Not used.

stream_read (line 186)

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.

see: http://www.php.net/manual/en/streamwrapper.stream-read.php
since: 11.1
access: public

void stream_read (integer $count)

integer $count: Bytes of data from the current position should be returned.

stream_seek (line 249)

Stream offset

return: True on success.
since: 11.1
access: public

boolean stream_seek (integer $offset, integer $whence)

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

stream_stat (line 135)

Method to retrieve information from a file resource

see: http://www.php.net/manual/en/streamwrapper.stream-stat.php
since: 11.1
access: public

array stream_stat ()

stream_tell (line 217)

Method to get the current position

return: The position
since: 11.1
access: public

integer stream_tell ()

stream_write (line 204)

Stream write, always returning false.

since: 11.1
access: public

boolean stream_write (string $data)

string $data: The data to write.

url_stat (line 151)

Method to retrieve information about a file.

see: http://php.net/manual/en/streamwrapper.url-stat.php
since: 11.1
access: public

array url_stat (string $path, [integer $flags = 0])

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