jFile
in package
A class helper to read or create files.
Tags
Table of Contents
- copyDirectoryContent() : mixed
- copy the whole content of a directory into an other.
- createDir() : mixed
- create a directory It creates also all necessary parent directory.
- getMimeType() : string
- get the MIME Type of a file.
- getMimeTypeFromFilename() : string
- get the MIME Type of a file, only with its name.
- normalizePath() : string
- normalize a path : translate '..', '.', replace '\' by '/' and so on.. support windows path.
- parseJelixPath() : string
- parse a path replacing Jelix shortcuts parts (var:, temp:, www:, app:, lib:).
- read() : string
- Reads the content of a file.
- removeDir() : bool
- Recursive function deleting a directory.
- shortestPath() : string
- calculate the shortest path between two directories.
- unparseJelixPath() : string
- replace a path with Jelix shortcuts parts (var:, temp:, www: app:, lib:).
- verifyFileMimeType() : false|string
- write() : mixed
- Write a file to the disk.
Methods
copyDirectoryContent()
copy the whole content of a directory into an other.
public
static copyDirectoryContent(string $sourcePath, string $targetPath[, mixed $overwrite = false ]) : mixed
Parameters
- $sourcePath : string
-
the path of the directory content. It does not create the directory itself into the target directory.
- $targetPath : string
-
the full path of the directory to where to copy the content. The directory is created if it does not exists.
- $overwrite : mixed = false
Tags
Return values
mixed —createDir()
create a directory It creates also all necessary parent directory.
public
static createDir(string $dir[, null|mixed $chmod = null ]) : mixed
Parameters
- $dir : string
-
the path of the directory
- $chmod : null|mixed = null
Tags
Return values
mixed —getMimeType()
get the MIME Type of a file.
public
static getMimeType(string $file) : string
Parameters
- $file : string
-
The full path of the file
Tags
Return values
string —the MIME type of the file
getMimeTypeFromFilename()
get the MIME Type of a file, only with its name.
public
static getMimeTypeFromFilename(string $fileName) : string
Parameters
- $fileName : string
-
the file name
Tags
Return values
string —the MIME type of the file
normalizePath()
normalize a path : translate '..', '.', replace '\' by '/' and so on.. support windows path.
public
static normalizePath(string $path) : string
Parameters
- $path : string
Tags
Return values
string —the normalized path
parseJelixPath()
parse a path replacing Jelix shortcuts parts (var:, temp:, www:, app:, lib:).
public
static parseJelixPath(string $path) : string
Parameters
- $path : string
-
the path with parts to replace
Tags
Return values
string —the path which is a system valid path
read()
Reads the content of a file.
public
static read(string $filename) : string
Parameters
- $filename : string
-
the filename we're gonna read
Tags
Return values
string —the content of the file. false if cannot read the file
removeDir()
Recursive function deleting a directory.
public
static removeDir(string $path[, bool $deleteParent = true ][, array<string|int, mixed> $except = array() ]) : bool
Parameters
- $path : string
-
The path of the directory to remove recursively
- $deleteParent : bool = true
-
If the path must be deleted too
- $except : array<string|int, mixed> = array()
-
filenames and suffix of filename, for files to NOT delete
Tags
Return values
bool —true if all the content has been removed
shortestPath()
calculate the shortest path between two directories.
public
static shortestPath(string $from, string $to) : string
Parameters
- $from : string
-
absolute path from which we should start
- $to : string
-
absolute path to which we should go
Tags
Return values
string —relative path between the two path
unparseJelixPath()
replace a path with Jelix shortcuts parts (var:, temp:, www: app:, lib:).
public
static unparseJelixPath(string $path[, string $beforeShortcut = '' ][, string $afterShortcut = '' ]) : string
Parameters
- $path : string
-
the system valid path
- $beforeShortcut : string = ''
-
a string to be output before the Jelix shortcut
- $afterShortcut : string = ''
-
a string to be output after the Jelix shortcut
Tags
Return values
string —the path with Jelix shortcuts parts
verifyFileMimeType()
public
static verifyFileMimeType(string $filePath, string|array<string|int, mixed> $allowedMimeTypes[, string $baseFileName = '' ]) : false|string
Parameters
- $filePath : string
-
the file for which we want to check the mime type
- $allowedMimeTypes : string|array<string|int, mixed>
-
list of allowed mime types
- $baseFileName : string = ''
-
the base filename if the filepath does not contain the real base filename (like uploaded files)
Tags
Return values
false|string —false if the file does not meet requirements, else the mime type of the file
write()
Write a file to the disk.
public
static write(mixed $file, mixed $data[, null|mixed $chmod = null ]) : mixed
This function is heavily based on the way smarty process its own files. Is using a temporary file and then rename the file. We guess the file system will be smarter than us, avoiding a writing / reading while renaming the file. This method comes from CopixFile class of Copix framework.
Parameters
- $file : mixed
- $data : mixed
- $chmod : null|mixed = null