Class JFilesystemWrapperFile
Methods summary
public
string
|
#
getExt( string $file )
Helper wrapper method for getExt
Helper wrapper method for getExt
Parameters
- $file
string - $file The file name. Returns
string - The file extension.
Since
3.4
See
|
public
string
|
#
stripExt( string $file )
Helper wrapper method for stripExt
Helper wrapper method for stripExt
Parameters
- $file
string - $file The file name. Returns
string - The file name without the extension.
Since
3.4
See
|
public
string
|
#
makeSafe( string $file )
Helper wrapper method for makeSafe
Helper wrapper method for makeSafe
Parameters
- $file
string - $file The name of the file [not full path]. Returns
string - The sanitised string.
Since
3.4
See
|
public
boolean
|
#
copy( string $src, string $dest, string $path = null, boolean $use_streams = false )
Helper wrapper method for copy
Helper wrapper method for copy
Parameters
- $src
string - $src The path to the source file.- $dest
string - $dest The path to the destination file.- $path
string - $path An optional base path to prefix to the file names.- $use_streams
boolean - $use_streams True to use streams. Returns
boolean - True on success.
Since
3.4
See
|
public
boolean
|
#
delete( mixed $file )
Helper wrapper method for delete
Helper wrapper method for delete
Parameters
- $file
mixed - $file The file name or an array of file names Returns
boolean - True on success.
Since
3.4
See
|
public
boolean
|
#
move( string $src, string $dest, string $path = '', boolean $use_streams = false )
Helper wrapper method for move
Helper wrapper method for move
Parameters
- $src
string - $src The path to the source file.- $dest
string - $dest The path to the destination file.- $path
string - $path An optional base path to prefix to the file names.- $use_streams
boolean - $use_streams True to use streams. Returns
boolean - True on success.
Since
3.4
See
|
public
mixed
|
#
read( string $filename, boolean $incpath = false, integer $amount = 0, integer $chunksize = 8192, integer $offset = 0 )
Helper wrapper method for read
Helper wrapper method for read
Parameters
- $filename
string - $filename The full file path.- $incpath
boolean - $incpath Use include path.- $amount
integer - $amount Amount of file to read.- $chunksize
integer - $chunksize Size of chunks to read.- $offset
integer - $offset Offset of the file. Returns
mixed - Returns file contents or boolean False if failed.
Since
3.4
See
|
public
boolean
|
#
write( string $file, string & $buffer, boolean $use_streams = false )
Helper wrapper method for write
Helper wrapper method for write
Parameters
- $file
string - $file The full file path.- $buffer
string - &$buffer The buffer to write.- $use_streams
boolean - $use_streams Use streams. Returns
boolean - True on success.
Since
3.4
See
|
public
boolean
|
#
upload( string $src, string $dest, boolean $use_streams = false )
Helper wrapper method for upload
Helper wrapper method for upload
Parameters
- $src
string - $src The name of the php (temporary) uploaded file.- $dest
string - $dest The path (including filename) to move the uploaded file to.- $use_streams
boolean - $use_streams True to use streams. Returns
boolean - True on success.
Since
3.4
See
|
public
boolean
|
#
exists( string $file )
Helper wrapper method for exists
Helper wrapper method for exists
Parameters
- $file
string - $file File path. Returns
boolean - True if path is a file.
Since
3.4
See
|
public
string
|
#
getName( string $file )
Helper wrapper method for getName
Helper wrapper method for getName
Parameters
- $file
string - $file File path. Returns
string - filename.
Since
3.4
See
|
Magic methods summary
