File
in package
File
Table of Contents
Methods
- baseName() : string|null
- Get file base name from path
- copy() : bool
- Copy file, symlink or directory
- createUniqueFileName() : string
- Generate unique filename
- delete() : bool
- Delete file or durectiry
- deleteDirectory() : bool
- Delete directory and all sub directories
- exists() : bool
- Check if file exists
- getClassesInFile() : array<string|int, mixed>|false
- Get php classes defined in file
- getExtension() : string
- Return file extension
- getMimetype() : string|false
- Get file mime type
- getSize() : int|false
- Return file size
- getSizeText() : string|array<string|int, mixed>
- Get file size text.
- isEmpty() : bool
- Return true if direcotry is empty
- isImageMimeType() : bool
- Return true if MIME type is image
- isWritable() : bool
- Return true if file is writtable
- makeDir() : bool
- Create directory
- read() : mixed|null
- Read file
- readJsonFile() : array<string|int, mixed>|false
- Load json file and return decoded array
- removeExtension() : string
- Remove file extension
- replaceExtension() : string
- Replace file extension
- replaceFileName() : string
- Replace file name witout file extension
- scanDir() : array<string|int, mixed>
- Get directory files
- setWritable() : bool
- Set file writtable
- write() : bool
- Write file
- writeEncoded() : bool
- Write encoded file
- writeUplaodedFile() : bool
- Undocumented function
Methods
baseName()
Get file base name from path
public
static baseName(string|null $path[, string $suffix = '' ]) : string|null
Parameters
- $path : string|null
- $suffix : string = ''
Return values
string|nullcopy()
Copy file, symlink or directory
public
static copy(string $from, string $to[, bool $overwrite = true ]) : bool
Parameters
- $from : string
- $to : string
- $overwrite : bool = true
Return values
boolcreateUniqueFileName()
Generate unique filename
public
static createUniqueFileName(string $fileName) : string
Parameters
- $fileName : string
Return values
stringdelete()
Delete file or durectiry
public
static delete(string $fileName) : bool
Parameters
- $fileName : string
Return values
booldeleteDirectory()
Delete directory and all sub directories
public
static deleteDirectory(string $path[, bool $skipMainFolder = true ]) : bool
Parameters
- $path : string
- $skipMainFolder : bool = true
Return values
boolexists()
Check if file exists
public
static exists(string $fileName) : bool
Parameters
- $fileName : string
Return values
boolgetClassesInFile()
Get php classes defined in file
public
static getClassesInFile(string $fileName) : array<string|int, mixed>|false
Parameters
- $fileName : string
Return values
array<string|int, mixed>|falsegetExtension()
Return file extension
public
static getExtension(string $fileName) : string
Parameters
- $fileName : string
Return values
stringgetMimetype()
Get file mime type
public
static getMimetype(string $fileName) : string|false
Parameters
- $fileName : string
Return values
string|falsegetSize()
Return file size
public
static getSize(string $fileName) : int|false
Parameters
- $fileName : string
Return values
int|falsegetSizeText()
Get file size text.
public
static getSizeText(int $size[, array<string|int, mixed> $labels = null ][, bool $asText = true ]) : string|array<string|int, mixed>
Parameters
- $size : int
- $labels : array<string|int, mixed> = null
- $asText : bool = true
Return values
string|array<string|int, mixed>isEmpty()
Return true if direcotry is empty
public
static isEmpty(string $path) : bool
Parameters
- $path : string
Return values
boolisImageMimeType()
Return true if MIME type is image
public
static isImageMimeType(string $mimeType) : bool
Parameters
- $mimeType : string
Return values
boolisWritable()
Return true if file is writtable
public
static isWritable(string $fileName) : bool
Parameters
- $fileName : string
Return values
boolmakeDir()
Create directory
public
static makeDir(string $path[, int $mode = 0755 ][, bool $recursive = true ]) : bool
Parameters
- $path : string
- $mode : int = 0755
- $recursive : bool = true
Return values
boolread()
Read file
public
static read(string $fileName) : mixed|null
Parameters
- $fileName : string
Return values
mixed|nullreadJsonFile()
Load json file and return decoded array
public
static readJsonFile(string $fileName[, array<string|int, mixed>|null $vars = null ]) : array<string|int, mixed>|false
Parameters
- $fileName : string
- $vars : array<string|int, mixed>|null = null
Return values
array<string|int, mixed>|falseremoveExtension()
Remove file extension
public
static removeExtension(string $fileName) : string
Parameters
- $fileName : string
Return values
stringreplaceExtension()
Replace file extension
public
static replaceExtension(string $fileName, string $extension) : string
Parameters
- $fileName : string
- $extension : string
Return values
stringreplaceFileName()
Replace file name witout file extension
public
static replaceFileName(string $fileName, string $newFileName) : string
Parameters
- $fileName : string
- $newFileName : string
Return values
stringscanDir()
Get directory files
public
static scanDir(string $path[, array<string|int, mixed> $skip = ['..', '.'] ]) : array<string|int, mixed>
Parameters
- $path : string
- $skip : array<string|int, mixed> = ['..', '.']
Return values
array<string|int, mixed>setWritable()
Set file writtable
public
static setWritable(string $fileName) : bool
Parameters
- $fileName : string
Return values
boolwrite()
Write file
public
static write(string $fileName, mixed $data[, int $flags = 0 ]) : bool
Parameters
- $fileName : string
- $data : mixed
- $flags : int = 0
Return values
boolwriteEncoded()
Write encoded file
public
static writeEncoded(string $fileName, mixed $encodedData[, int $flags = 0 ]) : bool
Parameters
- $fileName : string
- $encodedData : mixed
- $flags : int = 0
Return values
boolwriteUplaodedFile()
Undocumented function
public
static writeUplaodedFile(array<string|int, mixed> $file, string $path[, int $mode = null ][, int $flags = 0 ]) : bool
Parameters
- $file : array<string|int, mixed>
- $path : string
- $mode : int = null
- $flags : int = 0