Joomla! API

link	https://secure.php.net/manual/en/function.stream-get-wrappers.php PHP Stream Manual Stream Wrappers Stream Filters Socket Transports (used by some options, particularly HTTP proxy)
since	1.0

Constructor

__construct(string $writeprefix = '', string $readprefix = '', array $context = array())

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: arrayThe context options (optional).

Destructor

__destruct()

since	1.0

Stream contexts Builds the context from the array

_buildContext() : mixed

since	1.0

Response

mixed

Determine the appropriate 'filename' of a file

_getFilename(string $filename, string $mode, boolean $usePrefix, boolean $relative) : string

since	1.0

Arguments

$filename: stringOriginal filename of the file
$mode: stringMode string to retrieve the filename
$usePrefix: booleanControls the use of a prefix
$relative: booleanDetermines 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.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

Stream filters Append a filter to the chain

appendFilter(string $filtername, integer $readWrite = STREAM_FILTER_READ, array $params = array()) : mixed

link	https://secure.php.net/manual/en/function.stream-filter-append.php
since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

$filtername: stringThe key name of the filter.
$readWrite: integerOptional. 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.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Response

mixed

Chmod wrapper

chmod(string $filename = '', mixed $mode) : boolean

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

$filename: stringFile name.
$mode: mixedMode to use.

Response

boolean

Attempt to close a file handle

close() : boolean

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	`\Joomla\Filesystem\Exception\FilesystemException`

Response

boolean

Copy a file from src to dest

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

since	1.0
throws	`\Joomla\Filesystem\Exception\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: booleanControls the use of a prefix (optional).
$relative: booleanDetermines if the filename given is relative. Relative paths do not have JPATH_ROOT stripped.

Response

mixed

Delete a file

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

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

$filename: stringThe file path to delete.
$context: resourceA valid context resource (optional) created with stream_context_create.
$usePrefix: booleanControls the use of a prefix (optional).
$relative: booleanDetermines 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	https://secure.php.net/stream_context_create
since	1.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() : boolean

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Response

boolean

Retrieve the file size of the path

filesize() : mixed

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

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

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() : array

link	https://secure.php.net/manual/en/function.stream-get-meta-data.php
since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Response

arrayheader/metadata

Return the internal file handle

getFileHandle() : \Joomla\Filesystem\File

since	1.0

Response

\Joomla\Filesystem\Filehandler

Get a line from the stream source.

gets(integer $length) : mixed

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

$length: integerThe number of bytes (optional) to read.

Response

mixed

Creates a new stream object with appropriate prefix

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

static

see	\Joomla\Filesystem\Stream
since	1.0

Arguments

$usePrefix: booleanPrefix the connections for writing
$ua: stringUA User agent to use
$uamask: booleanUser agent masking (prefix Mozilla)

Response

\Joomla\Filesystem\Stream

Moves a file

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

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

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: booleanControls the use of a prefix (optional).
$relative: booleanDetermines 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', boolean $useIncludePath = false, resource $context = null, boolean $usePrefix = false, boolean $relative = false, boolean $detectprocessingmode = false) : boolean

Open a stream with some lazy loading smarts

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

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

Response

boolean

Prepend a filter to the chain

prependFilter(string $filtername, integer $readWrite = STREAM_FILTER_READ, array $params = array()) : mixed

link	https://secure.php.net/manual/en/function.stream-filter-prepend.php
since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

$filtername: stringThe key name of the filter.
$readWrite: integerOptional. Defaults to STREAM_FILTER_READ.
$params: arrayAn array of params for the stream_filter_prepend call.

Response

mixed

Read a file

read(integer $length) : mixed

Handles user space streams appropriately otherwise any read will return 8192

link	https://secure.php.net/manual/en/function.fread.php
since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

$length: integerLength 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, boolean $byindex = false) : boolean

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

$resource: resourceThe resource.
$byindex: booleanThe index of the filter.

Response

booleanResult of operation

Seek the file

seek(integer $offset, integer $whence = SEEK_SET) : boolean

Note: the return value is different to that of fseek

link	https://secure.php.net/manual/en/function.fseek.php
since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

$offset: integerOffset to use when seeking.
$whence: integerSeek mode to use.

Response

booleanTrue 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

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(array $context) : void

Format is the same as the options for stream_context_create

link	https://secure.php.net/stream_context_create
since	1.0

Arguments

$context: arrayOptions to create the context with

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

tell() : mixed

since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Response

mixed

Upload a file

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

since	1.0
throws	`\Joomla\Filesystem\Exception\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: booleanControls the use of a prefix (optional).
$relative: booleanDetermines if the filename given is relative. Relative paths do not have JPATH_ROOT stripped.

Response

mixed

File write

write(string &$string, integer $length, integer $chunk) : boolean

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	https://secure.php.net/manual/en/function.fwrite.php
since	1.0
throws	`\Joomla\Filesystem\Exception\FilesystemException`

Arguments

$string: stringReference to the string to write.
$length: integerLength of the string to write.
$chunk: integerSize of chunks to write in.

Response

boolean

Writes a chunk of data to a file.

writeFile(string $filename, string &$buffer) : boolean

since	1.0

Arguments

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

Response

boolean

File Mode

since	1.0

Type(s)

integer

Directory Mode

since	1.0

Type(s)

integer

Default Chunk Size

since	1.0

Type(s)

integer

Filename

since	1.0

Type(s)

string

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

File Handle

since	1.0

Type(s)

resource

File size

since	1.0

Type(s)

integer

Context to use when opening the connection

since	1.0

Type(s)

string

Context options; used to rebuild the context

since	1.0

Type(s)

array

The mode under which the file was opened

since	1.0

Type(s)

string

Stream

Methods

__construct

Arguments

__destruct

_buildContext

Response

_getFilename

Arguments

Response

addContextEntry

Arguments

appendFilter

Arguments

Response

applyContextToStream

Response

chmod

Arguments

Response

close

Response

copy

Arguments

Response

delete

Arguments

Response

deleteContextEntry

Arguments

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

tell

Response

upload

Arguments

Response

write

Arguments

Response

writeFile

Arguments