class JStreamString


Located at : UKNOWVA_ROOT/libraries/joomla/filesystem/streams/string.php

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

Methods

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

Method to open a file or URL.

array
stream_stat()

Method to retrieve informaion from a file resource

array
url_stat(string $path, integer $flags)

Method to rerieve information about a file.

stream_read(integer $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.

boolean
stream_write(string $data)

Stream write, always returning false.

integer
stream_tell()

Method to get the current position

boolean
stream_eof()

End of field check

boolean
stream_seek(integer $offset, integer $whence)

Stream offset

boolean
stream_flush()

Stream flush, always returns true.

Details

at line 109
boolean stream_open(string $path, string $mode, integer $options, string $opened_path)

Method to open a file or URL.

Parameters

string $path
string $mode
integer $options
string $opened_path

Return Value

boolean

at line 134
array stream_stat()

Method to retrieve informaion from a file resource

Return Value

array

See also

http://www.php.net/manual/en/streamwrapper.stream-stat.php

at line 151
array url_stat(string $path, integer $flags)

Method to rerieve information about a file.

Parameters

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

Return Value

array

See also

http://php.net/manual/en/streamwrapper.url-stat.php

at line 188
stream_read(integer $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.

Parameters

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

See also

http://www.php.net/manual/en/streamwrapper.stream-read.php

at line 207
boolean stream_write(string $data)

Stream write, always returning false.

Parameters

string $data

Return Value

boolean

at line 220
integer stream_tell()

Method to get the current position

Return Value

integer The position

at line 232
boolean stream_eof()

End of field check

Return Value

boolean True if at end of field.

at line 251
boolean stream_seek(integer $offset, integer $whence)

Stream offset

Parameters

integer $offset
integer $whence

Return Value

boolean True on success.

at line 291
boolean stream_flush()

Stream flush, always returns true.

Return Value

boolean