StringWrapper
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 |
1.3.0 |
|---|---|
| package |
Joomla Framework |
Methods
stream_eof
End of field check
stream_eof() : bool
| since |
1.3.0 |
|---|
Response
boolTrue if at end of field.
stream_flush
Stream flush, always returns true.
stream_flush() : bool
| since |
1.3.0 |
|---|---|
| note |
Data storage is not supported |
Response
bool
stream_open
Method to open a file or URL.
stream_open(string path, string mode, int options, string &openedPath) : bool
| since |
1.3.0 |
|---|
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(int count) : string
| link | |
|---|---|
| since |
1.3.0 |
Arguments
- count
intBytes of data from the current position should be returned.
Response
string
stream_seek
Stream offset
stream_seek(int offset, int whence) : bool
| since |
1.3.0 |
|---|
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() : array
| link | |
|---|---|
| since |
1.3.0 |
Response
array
stream_tell
Method to get the current position
stream_tell() : int
| since |
1.3.0 |
|---|
Response
intThe position
stream_write
Stream write, always returning false.
stream_write(string data) : bool
| since |
1.3.0 |
|---|---|
| note |
Updating the string is not supported. |
Arguments
- data
stringThe data to write.
Response
bool
url_stat
Method to retrieve information about a file.
url_stat(string path, int flags) : array
| link | |
|---|---|
| since |
1.3.0 |
Arguments
- path
stringFile path or URL to stat- flags
intAdditional flags set by the streams API
Response
array
Properties
currentString
The current string
| since |
1.3.0 |
|---|
Type(s)
string
path
The path
| since |
1.3.0 |
|---|
Type(s)
string
mode
The mode
| since |
1.3.0 |
|---|
Type(s)
string
options
Enter description here .
..
| since |
1.3.0 |
|---|
Type(s)
string
openedPath
Enter description here .
..
| since |
1.3.0 |
|---|
Type(s)
string
pos
Current position
| since |
1.3.0 |
|---|
Type(s)
int
len
Length of the string
| since |
1.3.0 |
|---|
Type(s)
string
stat
Statistics for a file
| since |
1.3.0 |
|---|---|
| link |
Type(s)
array