JFile
Description
A File handling class
Located in /joomla/filesystem/file.php (line 28)
JFile (Subpackage FileSystem)
Method Summary
mixed
read
(string $filename, [boolean $incpath = false], [int $amount = 0], [int $chunksize = 8192], [int $offset = 0])
Methods
Copies a file
boolean
copy
(string $src, string $dest, [string $path = null])
- string $src: The path to the source file
- string $dest: The path to the destination file
- string $path: An optional base path to prefix to the file names
Delete a file or array of files
boolean
delete
(mixed $file)
- mixed $file: The file name or an array of file names
Wrapper for the standard file_exists function
boolean
exists
(string $file)
- string $file: File path
Gets the extension of a file name
string
getExt
(string $file)
- string $file: The file name
Returns the name, sans any path
param string $file File path
string
getName
( $file)
- $file
Makes file name safe to use
string
makeSafe
(string $file)
- string $file: The name of the file [not full path]
Moves a file
boolean
move
(string $src, string $dest, [string $path = ''])
- string $src: The path to the source file
- string $dest: The path to the destination file
- string $path: An optional base path to prefix to the file names
Read the contents of a file
mixed
read
(string $filename, [boolean $incpath = false], int $amount, [int $chunksize = 8192], int $offset)
- string $filename: The full file path
- boolean $incpath: Use include path
- int $amount: Amount of file to read
- int $chunksize: Size of chunks to read
- int $offset: Offset of the file
Strips the last extension off a file name
string
stripExt
(string $file)
- string $file: The file name
Moves an uploaded file to a destination folder
boolean
upload
(string $src, string $dest)
- string $src: The name of the php (temporary) uploaded file
- string $dest: The path (including filename) to move the uploaded file to
Write contents to a file
boolean
write
(string $file, string $buffer)
- string $file: The full file path
- string $buffer: The buffer to write