StreamString

String Stream Wrapper

deprecated

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

since

1.7.0

deprecated

4.4 will be removed in 6.0 Use Joomla\Filesystem\Stream\StringWrapper instead.

package

Joomla CMS

Methods

stream_eof

End of field check

stream_eof() : 
deprecated
since

1.7.0

deprecated

4.4 will be removed in 6.0 Use Joomla\Filesystem\Stream\StringWrapper::stream_eof() instead.

Response

boolTrue if at end of field.

stream_flush

Stream flush, always returns true.

stream_flush() : 
deprecated
since

1.7.0

note

Data storage is not supported

deprecated

4.4 will be removed in 6.0 Use Joomla\Filesystem\Stream\StringWrapper::stream_flush() instead.

Response

bool

stream_open

Method to open a file or URL.

stream_open( path,  mode,  options,  &openedPath) : 
deprecated
since

1.7.0

deprecated

4.4 will be removed in 6.0 Use Joomla\Filesystem\Stream\StringWrapper::stream_open() instead.

Arguments

path

stringThe stream path.

mode

stringNot used.

options

intNot used.

openedPath

stringNot used.

Response

bool

stream_read

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.

stream_read( count) : 
deprecated
link
since

1.7.0

deprecated

4.4 will be removed in 6.0 Use Joomla\Filesystem\Stream\StringWrapper::stream_read() instead.

Arguments

count

intBytes of data from the current position should be returned.

Response

string

stream_seek

Stream offset

stream_seek( offset,  whence) : 
deprecated
since

1.7.0

deprecated

4.4 will be removed in 6.0 Use Joomla\Filesystem\Stream\StringWrapper::stream_seek() instead.

Arguments

offset

intThe starting offset.

whence

intSEEK_SET, SEEK_CUR, SEEK_END

Response

boolTrue on success.

stream_stat

Method to retrieve information from a file resource

stream_stat() : mixed||string|int
deprecated
link
since

1.7.0

deprecated

4.4 will be removed in 6.0 Use Joomla\Filesystem\Stream\StringWrapper::stream_stat instead.

Response

array<string|int, mixed>

stream_tell

Method to get the current position

stream_tell() : 
deprecated
since

1.7.0

deprecated

4.4 will be removed in 6.0 Use Joomla\Filesystem\Stream\StringWrapper::stream_tell() instead.

Response

intThe position

stream_write

Stream write, always returning false.

stream_write( data) : 
deprecated
since

1.7.0

note

Updating the string is not supported.

deprecated

4.4 will be removed in 6.0 Use Joomla\Filesystem\Stream\StringWrapper::stream_write() instead.

Arguments

data

stringThe data to write.

Response

bool

url_stat

Method to retrieve information about a file.

url_stat( path,  flags) : mixed||string|int
deprecated
link
since

1.7.0

deprecated

4.4 will be removed in 6.0 Use Joomla\Filesystem\Stream\StringWrapper::url_stat() instead.

Arguments

path

stringFile path or URL to stat

flags

intAdditional flags set by the streams API

Response

array<string|int, mixed>

Properties

currentString

The current string

since

3.0.0

Type(s)

string

path

The path

since

3.0.0

Type(s)

string

mode

The mode

since

3.0.0

Type(s)

string

options

Enter description here .

..

since

3.0.0

Type(s)

string

openedPath

Enter description here .

..

since

3.0.0

Type(s)

string

pos

Current position

since

3.0.0

Type(s)

int

len

Length of the string

since

3.0.0

Type(s)

string

stat

Statistics for a file

since

3.0.0

link

Type(s)

array<string|int, mixed>