FileWrapper

Wrapper class for File

deprecated
package

Joomla.Platform

subpackage

Filesystem

since

3.4

deprecated

4.0 Use \Joomla\CMS\Filesystem\File instead

Methods

copy

Helper wrapper method for copy

copy(string $src, string $dest, string $path = null, boolean $use_streams = false) : boolean
deprecated
see \Joomla\Filesystem\File::copy()
since

3.4

deprecated

4.0 Use \Joomla\CMS\Filesystem\File instead

Arguments

$src

stringThe path to the source file.

$dest

stringThe path to the destination file.

$path

stringAn optional base path to prefix to the file names.

$use_streams

booleanTrue to use streams.

Response

booleanTrue on success.

delete

Helper wrapper method for delete

delete(mixed $file) : boolean
deprecated
see \Joomla\Filesystem\File::delete()
since

3.4

deprecated

4.0 Use \Joomla\CMS\Filesystem\File instead

Arguments

$file

mixedThe file name or an array of file names

Response

booleanTrue on success.

exists

Helper wrapper method for exists

exists(string $file) : boolean
deprecated
see \Joomla\Filesystem\File::exists()
since

3.4

deprecated

4.0 Use \Joomla\CMS\Filesystem\File instead

Arguments

$file

stringFile path.

Response

booleanTrue if path is a file.

getExt

Helper wrapper method for getExt

getExt(string $file) : string
deprecated
see \Joomla\Filesystem\File::getExt()
since

3.4

deprecated

4.0 Use \Joomla\CMS\Filesystem\File instead

Arguments

$file

stringThe file name.

Response

stringThe file extension.

getName

Helper wrapper method for getName

getName(string $file) : string
deprecated
see \Joomla\Filesystem\File::getName()
since

3.4

deprecated

4.0 Use \Joomla\CMS\Filesystem\File instead

Arguments

$file

stringFile path.

Response

stringfilename.

makeSafe

Helper wrapper method for makeSafe

makeSafe(string $file) : string
deprecated
see \Joomla\Filesystem\File::makeSafe()
since

3.4

deprecated

4.0 Use \Joomla\CMS\Filesystem\File instead

Arguments

$file

stringThe name of the file [not full path].

Response

stringThe sanitised string.

move

Helper wrapper method for move

move(string $src, string $dest, string $path = '', boolean $use_streams = false) : boolean
deprecated
see \Joomla\Filesystem\File::move()
since

3.4

deprecated

4.0 Use \Joomla\CMS\Filesystem\File instead

Arguments

$src

stringThe path to the source file.

$dest

stringThe path to the destination file.

$path

stringAn optional base path to prefix to the file names.

$use_streams

booleanTrue to use streams.

Response

booleanTrue on success.

read

Helper wrapper method for read

read(string $filename, boolean $incpath = false, integer $amount, integer $chunksize = 8192, integer $offset) : mixed
deprecated
see \Joomla\Filesystem\File::read()
since

3.4

deprecated

4.0 Use \Joomla\CMS\Filesystem\File instead

Arguments

$filename

stringThe full file path.

$incpath

booleanUse include path.

$amount

integerAmount of file to read.

$chunksize

integerSize of chunks to read.

$offset

integerOffset of the file.

Response

mixedReturns file contents or boolean False if failed.

stripExt

Helper wrapper method for stripExt

stripExt(string $file) : string
deprecated
see \Joomla\Filesystem\File::stripExt()
since

3.4

deprecated

4.0 Use \Joomla\CMS\Filesystem\File instead

Arguments

$file

stringThe file name.

Response

stringThe file name without the extension.

upload

Helper wrapper method for upload

upload(string $src, string $dest, boolean $use_streams = false) : boolean
deprecated
see \Joomla\Filesystem\File::upload()
since

3.4

deprecated

4.0 Use \Joomla\CMS\Filesystem\File instead

Arguments

$src

stringThe name of the php (temporary) uploaded file.

$dest

stringThe path (including filename) to move the uploaded file to.

$use_streams

booleanTrue to use streams.

Response

booleanTrue on success.

write

Helper wrapper method for write

write(string $file,  &$buffer, boolean $use_streams = false) : boolean
deprecated
see \Joomla\Filesystem\File::write()
since

3.4

deprecated

4.0 Use \Joomla\CMS\Filesystem\File instead

Arguments

$file

stringThe full file path.

$buffer

$use_streams

booleanUse streams.

Response

booleanTrue on success.