String

Extends \Joomla\Filesystem\Stream\StringWrapper

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.0

deprecated

2.0 Use StringWrapper instead

Methods

stream_eof

End of field check

stream_eof() : boolean
inherited
since

1.3.0

Response

booleanTrue if at end of field.

stream_flush

Stream flush, always returns true.

stream_flush() : boolean
inherited
since

1.3.0

note

Data storage is not supported

Response

boolean

stream_open

Method to open a file or URL.

stream_open(string $path, string $mode, integer $options, string &$openedPath) : boolean
inherited
since

1.3.0

Arguments

$path

stringThe stream path.

$mode

stringNot used.

$options

integerNot used.

$openedPath

stringNot used.

Response

boolean

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(integer $count) : string
inherited
link

https://secure.php.net/manual/en/streamwrapper.stream-read.php

since

1.3.0

Arguments

$count

integerBytes of data from the current position should be returned.

Response

string

stream_seek

Stream offset

stream_seek(integer $offset, integer $whence) : boolean
inherited
since

1.3.0

Arguments

$offset

integerThe starting offset.

$whence

integerSEEK_SET, SEEK_CUR, SEEK_END

Response

booleanTrue on success.

stream_stat

Method to retrieve information from a file resource

stream_stat() : array
inherited

stream_tell

Method to get the current position

stream_tell() : integer
inherited
since

1.3.0

Response

integerThe position

stream_write

Stream write, always returning false.

stream_write(string $data) : boolean
inherited
since

1.3.0

note

Updating the string is not supported.

Arguments

$data

stringThe data to write.

Response

boolean

url_stat

Method to retrieve information about a file.

url_stat(string $path, integer $flags) : array
inherited
link

https://secure.php.net/manual/en/streamwrapper.url-stat.php

since

1.3.0

Arguments

$path

stringFile path or URL to stat

$flags

integerAdditional flags set by the streams API

Response

array

Properties

currentString

The current string

inherited
since

1.3.0

Type(s)

string

path

The path

inherited
since

1.3.0

Type(s)

string

mode

The mode

inherited
since

1.3.0

Type(s)

string

options

Enter description here .

inherited

..

since

1.3.0

Type(s)

string

openedPath

Enter description here .

inherited

..

since

1.3.0

Type(s)

string

pos

Current position

inherited
since

1.3.0

Type(s)

integer

len

Length of the string

inherited
since

1.3.0

Type(s)

string

stat

Statistics for a file

inherited