Joomla! API

note	This class adheres to the stream wrapper operations:
link	PHP Stream Manual Stream Wrappers Stream Filters Socket Transports (used by some options, particularly HTTP proxy)
since	1.7.0
package	Joomla CMS

Class constructor, overridden in descendant classes.

__construct(mixed properties = null) : mixed

inherited

since	1.7.0

Arguments

properties: mixedEither and associative array or another object to set the initial properties of the object.

Response

mixed

Destructor

__destruct() : mixed

since	1.7.0

Response

mixed

Magic method to convert the object to a string gracefully.

__toString() : string

inherited deprecated

since	1.7.0
deprecated	12.3 Classes should provide their own __toString() implementation.

Response

stringThe classname.

Stream contexts Builds the context from the array

_buildContext() : mixed

since	1.7.0

Response

mixed

Determine the appropriate 'filename' of a file

_getFilename(string filename, string mode, bool usePrefix, bool relative) : string

since	1.7.0

Arguments

filename: stringOriginal filename of the file
mode: stringMode string to retrieve the filename
usePrefix: boolControls the use of a prefix
relative: boolDetermines if the filename given is relative. Relative paths do not have JPATH_ROOT stripped.

Response

string

Adds a particular options to the context

addContextEntry(string wrapper, string name, string value) : void

link	Stream Context Creation Context Options for various streams
since	1.7.0

link

Stream Context Creation

Context Options for various streams

since

1.7.0

Arguments

wrapper: stringThe wrapper to use
name: stringThe option to set
value: stringThe value of the option

Stream filters Append a filter to the chain

appendFilter(string filterName, int readWrite = STREAM_FILTER_READ, array params = array()) : mixed

link
since	1.7.0

Arguments

filterName: stringThe key name of the filter.
readWrite: intOptional. Defaults to STREAM_FILTER_READ.
params: arrayAn array of params for the stream_filter_append call.

Response

mixed

Applies the current context to the stream

applyContextToStream() : mixed

Use this to change the values of the context after you've opened a stream

since	1.7.0

Response

mixed

Chmod wrapper

chmod(string filename = '', mixed mode) : bool

since	1.7.0

Arguments

filename: stringFile name.
mode: mixedMode to use.

Response

bool

Attempt to close a file handle

close() : bool

Will return false if it failed and true on success If the file is not open the system will return true, this function destroys the file handle as well

since	1.7.0

Response

bool

Copy a file from src to dest

copy(string src, string dest, resource context = null, bool usePrefix = true, bool relative = false) : mixed

since	1.7.0

Arguments

src: stringThe file path to copy from.
dest: stringThe file path to copy to.
context: resourceA valid context resource (optional) created with stream_context_create.
usePrefix: boolControls the use of a prefix (optional).
relative: boolDetermines if the filename given is relative. Relative paths do not have JPATH_ROOT stripped.

Response

mixed

Sets a default value if not already assigned

def(string property, mixed default = null) : mixed

inherited

since	1.7.0

Arguments

property: stringThe name of the property.
default: mixedThe default value.

Response

mixed

Delete a file

delete(string filename, resource context = null, bool usePrefix = true, bool relative = false) : mixed

since	1.7.0

Arguments

filename: stringThe file path to delete.
context: resourceA valid context resource (optional) created with stream_context_create.
usePrefix: boolControls the use of a prefix (optional).
relative: boolDetermines if the filename given is relative. Relative paths do not have JPATH_ROOT stripped.

Response

mixed

Deletes a particular setting from a context

deleteContextEntry(string wrapper, string name) : void

link
since	1.7.0

Arguments

wrapper: stringThe wrapper to use
name: stringThe option to unset

Work out if we're at the end of the file for a stream

eof() : bool

since	1.7.0

Response

bool

Retrieve the file size of the path

filesize() : mixed

since	1.7.0

Response

mixed

Returns a property of the object or the default value if the property is not set.

get(string property, mixed default = null) : mixed

inherited

since	1.7.0
see	CMSObject::getProperties()

Arguments

property: stringThe name of the property.
default: mixedThe default value.

Response

mixedThe value of the property.

Get the stream metadata

get_meta_data() : array

link
since	1.7.0

Response

arrayheader/metadata

Get the most recent error message.

getError(int i = null, bool toString = true) : string

inherited deprecated

since	1.7.0
see	JError
deprecated	12.3 JError has been deprecated

Arguments

i: intOption error index.
toString: boolIndicates if JError objects should return their error message.

Response

stringError message

Return all errors, if any.

getErrors() : array

inherited deprecated

since	1.7.0
see	JError
deprecated	12.3 JError has been deprecated

Response

arrayArray of error messages or JErrors.

Return the internal file handle

getFileHandle() : resource

since	1.7.0

Response

resourceFile handler

Returns an associative array of object properties.

getProperties(bool public = true) : array

inherited

since	1.7.0
see	CMSObject::get()

Arguments

public: boolIf true, returns only the public properties.

Response

array

Get a line from the stream source.

gets(int length) : mixed

since	1.7.0

Arguments

length: intThe number of bytes (optional) to read.

Response

mixed

Moves a file

move(string src, string dest, resource context = null, bool usePrefix = true, bool relative = false) : mixed

since	1.7.0

Arguments

src: stringThe file path to move from.
dest: stringThe file path to move to.
context: resourceA valid context resource (optional) created with stream_context_create.
usePrefix: boolControls the use of a prefix (optional).
relative: boolDetermines if the filename given is relative. Relative paths do not have JPATH_ROOT stripped.

Response

mixed

Generic File Operations

open(string filename, string mode = 'r', bool useIncludePath = false, resource context = null, bool usePrefix = false, bool relative = false, bool detectProcessingMode = false) : bool

Open a stream with some lazy loading smarts

since	1.7.0

Arguments

filename: stringFilename
mode: stringMode string to use
useIncludePath: boolUse the PHP include path
context: resourceContext to use when opening
usePrefix: boolUse a prefix to open the file
relative: boolFilename is a relative path (if false, strips JPATH_ROOT to make it relative)
detectProcessingMode: boolDetect the processing method for the file and use the appropriate function to handle output automatically

Response

bool

Prepend a filter to the chain

prependFilter(string filterName, int readWrite = STREAM_FILTER_READ, array params = array()) : mixed

link
since	1.7.0

Arguments

filterName: stringThe key name of the filter.
readWrite: intOptional. Defaults to STREAM_FILTER_READ.
params: arrayAn array of params for the stream_filter_prepend call.

Response

mixed

Read a file

read(int length) : mixed

Handles user space streams appropriately otherwise any read will return 8192

link
since	1.7.0

Arguments

length: intLength of data to read

Response

mixed

Remove a filter, either by resource (handed out from the append or prepend function) or via getting the filter list)

removeFilter(resource &resource, bool byindex = false) : bool

since	1.7.0

Arguments

resource: resourceThe resource.
byindex: boolThe index of the filter.

Response

boolResult of operation

Seek the file

seek(int offset, int whence = SEEK_SET) : bool

Note: the return value is different to that of fseek

link
since	1.7.0

Arguments

offset: intOffset to use when seeking.
whence: intSeek mode to use.

Response

boolTrue on success, false on failure

Modifies a property of the object, creating it if it does not already exist.

set(string property, mixed value = null) : mixed

inherited

since	1.7.0

Arguments

property: stringThe name of the property.
value: mixedThe value of the property to set.

Response

mixedPrevious value of the property.

Updates the context to the array

setContextOptions(array context) : void

Format is the same as the options for stream_context_create

link
since	1.7.0

Arguments

context: arrayOptions to create the context with

Add an error message.

setError(string error) : void

inherited deprecated

since	1.7.0
see	JError
deprecated	12.3 JError has been deprecated

Arguments

error: stringError message.

Set the object properties based on a named array/hash.

setProperties(mixed properties) : bool

inherited

since	1.7.0
see	CMSObject::set()

Arguments

properties: mixedEither an associative array or another object.

Response

bool

Returns the current position of the file read/write pointer.

tell() : mixed

since	1.7.0

Response

mixed

Upload a file

upload(string src, string dest, resource context = null, bool usePrefix = true, bool relative = false) : mixed

since	1.7.0

Arguments

src: stringThe file path to copy from (usually a temp folder).
dest: stringThe file path to copy to.
context: resourceA valid context resource (optional) created with stream_context_create.
usePrefix: boolControls the use of a prefix (optional).
relative: boolDetermines if the filename given is relative. Relative paths do not have JPATH_ROOT stripped.

Response

mixed

File write

write(string &string, int length, int chunk) : bool

Whilst this function accepts a reference, the underlying fwrite will do a copy! This will roughly double the memory allocation for any write you do. Specifying chunked will get around this by only writing in specific chunk sizes. This defaults to 8192 which is a sane number to use most of the time (change the default with JStream::set('chunksize', newsize);) Note: This doesn't support gzip/bzip2 writing like reading does

link
since	1.7.0

Arguments

string: stringReference to the string to write.
length: intLength of the string to write.
chunk: intSize of chunks to write in.

Response

bool

Writes a chunk of data to a file.

writeFile(string filename, string &buffer) : bool

since	1.7.0

Arguments

filename: stringThe file name.
buffer: stringThe data to write to the file.

Response

bool

File Mode

since	1.7.0

Type(s)

int

Directory Mode

since	1.7.0

Type(s)

int

Default Chunk Size

since	1.7.0

Type(s)

int

Filename

since	1.7.0

Type(s)

string

Prefix of the connection for writing

since	1.7.0

Type(s)

string

Prefix of the connection for reading

since	1.7.0

Type(s)

string

Read Processing method

since	1.7.0

Type(s)

string

Filters applied to the current stream

since	1.7.0

Type(s)

array

File Handle

since	3.0.0

Type(s)

resource

File size

since	3.0.0

Type(s)

int

Context to use when opening the connection

since	3.0.0

Type(s)

resource

Context options; used to rebuild the context

since	3.0.0

Type(s)

array

The mode under which the file was opened

since	3.0.0

Type(s)

string

An array of error messages or Exception objects.

inherited deprecated

since	1.7.0
see	JError
deprecated	12.3 JError has been deprecated

Type(s)

array

Stream

Methods

__construct

Arguments

Response

__destruct

Response

__toString

Response

_buildContext

Response

_getFilename

Arguments

Response

addContextEntry

Arguments

appendFilter

Arguments

Response

applyContextToStream

Response

chmod

Arguments

Response

close

Response

copy

Arguments

Response

def

Arguments

Response

delete

Arguments

Response

deleteContextEntry

Arguments

eof

Response

filesize

Response

get

Arguments

Response

get_meta_data

Response

getError

Arguments

Response

getErrors

Response

getFileHandle

Response

getProperties

Arguments

Response

gets

Arguments

Response

move

Arguments

Response

open

Arguments

Response

prependFilter

Arguments

Response

read

Arguments

Response

removeFilter

Arguments

Response

seek

Arguments

Response

set

Arguments

Response