Joomla! API

link	PHP Stream Manual Stream Wrappers Stream Filters Socket Transports (used by some options, particularly HTTP proxy)
since	1.0
package	Joomla Framework

Constructor

__construct( writeprefix = '',  readprefix = '', mixed||string|int context = []) :

since	1.0

Arguments

writeprefix: stringPrefix of the stream (optional). Unlike the JPATH_*, this has a final path separator!
readprefix: stringThe read prefix (optional).
context: array<string|int, mixed>The context options (optional).

Response

mixed

Destructor

__destruct() :

since	1.0

Response

mixed

Stream contexts Builds the context from the array

_buildContext() :

since	1.0

Response

void

Determine the appropriate 'filename' of a file

_getFilename( filename,  mode,  usePrefix,  relative) :

since	1.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( wrapper,  name,  value) :

link	Stream Context Creation Context Options for various streams
since	1.0

link

Stream Context Creation

Context Options for various streams

since

1.0

Arguments

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

Response

void

Stream filters Append a filter to the chain

appendFilter( filtername,  readWrite = STREAM_FILTER_READ, mixed||string|int params = []) : resource|bool

link
since	1.0
throws	`FilesystemException`

Arguments

filtername: stringThe key name of the filter.
readWrite: intOptional. Defaults to STREAM_FILTER_READ.
params: array<string|int, mixed>An array of params for the stream_filter_append call.

Response

resource|bool

Applies the current context to the stream

applyContextToStream() :

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

since	1.0
throws	`FilesystemException`

Response

bool

Chmod wrapper

chmod( filename = '',  mode) :

since	1.0
throws	`FilesystemException`

Arguments

filename: stringFile name.
mode: mixedMode to use.

Response

bool

Attempt to close a file handle

close() :

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.0
throws	`FilesystemException`

Response

bool

Copy a file from src to dest

copy( src,  dest,  context = null,  usePrefix = true,  relative = false) :

since	1.0
throws	`FilesystemException`

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

bool

Delete a file

delete( filename,  context = null,  usePrefix = true,  relative = false) :

since	1.0
throws	`FilesystemException`

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

bool

Deletes a particular setting from a context

deleteContextEntry( wrapper,  name) :

link
since	1.0

Arguments

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

Response

void

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

eof() :

since	1.0
throws	`FilesystemException`

Response

bool

Retrieve the file size of the path

filesize() : int|bool

since	1.0
throws	`FilesystemException`

Response

int|bool

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

get( property,  default = null) :

since	1.0

Arguments

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

Response

mixedThe value of the property.

Get the stream metadata

get_meta_data() : mixed||string|int

link
since	1.0
throws	`FilesystemException`

Response

array<string|int, mixed>header/metadata

Return the internal file handle

getFileHandle() : resource

since	1.0

Response

resource|nullhandler

Get a line from the stream source.

gets( length) :

since	1.0
throws	`FilesystemException`

Arguments

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

Response

string

Creates a new stream object with appropriate prefix

getStream( usePrefix = true,  ua = null,  uamask = false) : \Joomla\Filesystem\Stream

static

see	Stream
since	1.0

Arguments

usePrefix: boolPrefix the connections for writing
ua: stringUA User agent to use
uamask: boolUser agent masking (prefix Mozilla)

Response

Stream

Moves a file

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

since	1.0
throws	`FilesystemException`

Arguments

src: stringThe file path to move from.
dest: stringThe file path to move to.
context: resource|nullA 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

bool

Generic File Operations

open( filename,  mode = 'r',  useIncludePath = false,  context = null,  usePrefix = false,  relative = false,  detectprocessingmode = false) :

Open a stream with some lazy loading smarts

since	1.0
throws	`FilesystemException`

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( filtername,  readWrite = STREAM_FILTER_READ, mixed||string|int params = []) : resource|bool

link
since	1.0
throws	`FilesystemException`

Arguments

filtername: stringThe key name of the filter.
readWrite: intOptional. Defaults to STREAM_FILTER_READ.
params: array<string|int, mixed>An array of params for the stream_filter_prepend call.

Response

resource|bool

Read a file

read( length) :

Handles user space streams appropriately otherwise any read will return 8192

link
since	1.0
throws	`FilesystemException`

Arguments

length: intLength of data to read

Response

string

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

removeFilter( &resource,  byindex = false) :

since	1.0
throws	`FilesystemException`

Arguments

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

Response

boolResult of operation

Seek the file

seek( offset,  whence = SEEK_SET) :

Note: the return value is different to that of fseek

link
since	1.0
throws	`FilesystemException`

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( property,  value = null) :

since	1.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(mixed||string|int context) :

Format is the same as the options for stream_context_create

link
since	1.0

Arguments

context: array<string|int, mixed>Options to create the context with

Response

void

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

tell() :

since	1.0
throws	`FilesystemException`

Response

int

Upload a file

upload( src,  dest,  context = null,  usePrefix = true,  relative = false) :

since	1.0
throws	`FilesystemException`

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

bool

File write

write( &string,  length,  chunk) :

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 Stream::set('chunksize', newsize);) Note: This doesn't support gzip/bzip2 writing like reading does

link
since	1.0
throws	`FilesystemException`

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( filename,  &buffer,  appendToFile = false) :

since	1.0

Arguments

filename: stringThe file name.
buffer: stringThe data to write to the file.
appendToFile: boolAppend to the file and not overwrite it.

Response

bool

File Mode

since	1.0

Type(s)

int

Directory Mode

since	1.0

Type(s)

int

Default Chunk Size

since	1.0

Type(s)

int

Filename

since	1.0

Type(s)

string|null

Prefix of the connection for writing

since	1.0

Type(s)

string

Prefix of the connection for reading

since	1.0

Type(s)

string

Read Processing method

since	1.0

Type(s)

string

Filters applied to the current stream

since	1.0

Type(s)

array<string|int, mixed>

File Handle

since	1.0

Type(s)

resource|null

File size

since	1.0

Type(s)

int

Context to use when opening the connection

since	1.0

Type(s)

resource|null

Context options; used to rebuild the context

since	1.0

Type(s)

array<string|int, mixed>

The mode under which the file was opened

since	1.0

Type(s)

string

Stream

Methods

__construct

Arguments

Response

__destruct

Response

_buildContext

Response

_getFilename

Arguments

Response

addContextEntry

Arguments

Response

appendFilter

Arguments

Response

applyContextToStream

Response

chmod

Arguments

Response

close

Response

copy

Arguments

Response

delete

Arguments

Response

deleteContextEntry

Arguments

Response

eof

Response

filesize

Response

get

Arguments

Response

get_meta_data

Response

getFileHandle

Response

gets

Arguments

Response

getStream

Arguments

Response

move

Arguments

Response

open

Arguments

Response

prependFilter

Arguments

Response

read

Arguments

Response

removeFilter

Arguments

Response

seek

Arguments

Response

set

Arguments

Response

setContextOptions

Arguments

Response

tell

Response

upload

Arguments

Response