Class File
Convenience class for reading, writing and appending to files.
Property Summary
Method Summary
-
__construct() public
Constructor
-
__destruct() public
Closes the current file if it is opened
-
append() public
Append given data string to this file.
-
clearStatCache() public
Clear PHP's internal stat cache
-
close() public
Closes the current file if it is opened.
-
copy() public
Copy the File to $dest
-
create() public
Creates the file.
-
delete() public
Deletes the file.
-
executable() public
Returns true if the File is executable.
-
exists() public
Returns true if the file exists.
-
ext() public
Returns the file extension.
-
folder() public
Returns the current folder.
-
group() public
Returns the file's group.
-
info() public
Returns the file info as an array with the following keys:
-
lastAccess() public
Returns last access time.
-
lastChange() public
Returns last modified time.
-
md5() public
Get md5 Checksum of file with previous check of Filesize
-
mime() public
Get the mime type of the file. Uses the finfo extension if its available, otherwise falls back to mime_content_type
-
name() public
Returns the file name without extension.
-
offset() public
Sets or gets the offset for the currently opened file.
-
open() public
Opens the current file with a given $mode
-
owner() public
Returns the file's owner.
-
perms() public
Returns the "chmod" (permissions) of the file.
-
prepare() public static
Prepares an ASCII string for writing. Converts line endings to the correct terminator for the current platform. If Windows, "\r\n" will be used, all other platforms will use "\n"
-
pwd() public
Returns the full path of the file.
-
read() public
Return the contents of this file as a string.
-
readable() public
Returns true if the file is readable.
-
replaceText() public
Searches for a given text and replaces the text if found.
-
safe() public
Makes file name safe for saving
-
size() public
Returns the file size
-
writable() public
Returns true if the file is writable.
-
write() public
Write given data to this file.
Method Detail
__construct() ¶ public
__construct(string $path, bool $create = false, int $mode = 0755)Constructor
Parameters
-
string$path Path to file
-
bool$create optional Create file if it does not exist (if true)
-
int$mode optional Mode to apply to the folder holding the file
Links
append() ¶ public
append(string $data, bool $force = false): boolAppend given data string to this file.
Parameters
-
string$data Data to write
-
bool$force optional Force the file to open
Returns
boolSuccess
clearStatCache() ¶ public
clearStatCache(bool $all = false): voidClear PHP's internal stat cache
Parameters
-
bool$all optional Clear all cache or not. Passing false will clear the stat cache for the current path only.
Returns
voidclose() ¶ public
close(): boolCloses the current file if it is opened.
Returns
boolTrue if closing was successful or file was already closed, otherwise false
copy() ¶ public
copy(string $dest, bool $overwrite = true): boolCopy the File to $dest
Parameters
-
string$dest Destination for the copy
-
bool$overwrite optional Overwrite $dest if exists
Returns
boolSuccess
executable() ¶ public
executable(): boolReturns true if the File is executable.
Returns
boolTrue if it's executable, false otherwise
exists() ¶ public
exists(): boolReturns true if the file exists.
Returns
boolTrue if it exists, false otherwise
ext() ¶ public
ext(): string|falseReturns the file extension.
Returns
string|falseThe file extension, false if extension cannot be extracted.
folder() ¶ public
folder(): Cake\Filesystem\FolderReturns the current folder.
Returns
Cake\Filesystem\FolderCurrent folder
group() ¶ public
group(): int|falseReturns the file's group.
Returns
int|falseThe file group, or false in case of an error
info() ¶ public
info(): arrayReturns the file info as an array with the following keys:
- dirname
- basename
- extension
- filename
- filesize
- mime
Returns
arrayFile information.
lastAccess() ¶ public
lastAccess(): int|falseReturns last access time.
Returns
int|falseTimestamp of last access time, or false in case of an error
lastChange() ¶ public
lastChange(): int|falseReturns last modified time.
Returns
int|falseTimestamp of last modification, or false in case of an error
md5() ¶ public
md5(int|bool $maxsize = 5): string|falseGet md5 Checksum of file with previous check of Filesize
Parameters
-
int|bool$maxsize optional in MB or true to force
Returns
string|falsemd5 Checksum {@link http://php.net/md5_file See md5_file()}, or false in case of an error
mime() ¶ public
mime(): false|stringGet the mime type of the file. Uses the finfo extension if its available, otherwise falls back to mime_content_type
Returns
false|stringThe mimetype of the file, or false if reading fails.
name() ¶ public
name(): string|falseReturns the file name without extension.
Returns
string|falseThe file name without extension, false if name cannot be extracted.
offset() ¶ public
offset(int|bool $offset = false, int $seek = SEEK_SET): int|boolSets or gets the offset for the currently opened file.
Parameters
-
int|bool$offset optional The $offset in bytes to seek. If set to false then the current offset is returned.
-
int$seek optional PHP Constant SEEK_SET | SEEK_CUR | SEEK_END determining what the $offset is relative to
Returns
int|boolTrue on success, false on failure (set mode), false on failure or integer offset on success (get mode)
open() ¶ public
open(string $mode = 'r', bool $force = false): boolOpens the current file with a given $mode
Parameters
-
string$mode optional A valid 'fopen' mode string (r|w|a ...)
-
bool$force optional If true then the file will be re-opened even if its already opened, otherwise it won't
Returns
boolTrue on success, false on failure
owner() ¶ public
owner(): int|falseReturns the file's owner.
Returns
int|falseThe file owner, or false in case of an error
perms() ¶ public
perms(): string|falseReturns the "chmod" (permissions) of the file.
Returns
string|falsePermissions for the file, or false in case of an error
prepare() ¶ public static
prepare(string $data, bool $forceWindows = false): stringPrepares an ASCII string for writing. Converts line endings to the correct terminator for the current platform. If Windows, "\r\n" will be used, all other platforms will use "\n"
Parameters
-
string$data Data to prepare for writing.
-
bool$forceWindows optional If true forces Windows new line string.
Returns
stringThe with converted line endings.
pwd() ¶ public
pwd(): stringReturns the full path of the file.
Returns
stringFull path to the file
read() ¶ public
read(string|bool $bytes = false, string $mode = 'rb', bool $force = false): string|falseReturn the contents of this file as a string.
Parameters
-
string|bool$bytes optional where to start
-
string$mode optional A
freadcompatible mode.-
bool$force optional If true then the file will be re-opened even if its already opened, otherwise it won't
Returns
string|falsestring on success, false on failure
readable() ¶ public
readable(): boolReturns true if the file is readable.
Returns
boolTrue if file is readable, false otherwise
replaceText() ¶ public
replaceText(string|array $search, string|array $replace): boolSearches for a given text and replaces the text if found.
Parameters
-
string|array$search Text(s) to search for.
-
string|array$replace Text(s) to replace with.
Returns
boolSuccess
safe() ¶ public
safe(string|null $name = null, string|null $ext = null): stringMakes file name safe for saving
Parameters
-
string|null$name optional The name of the file to make safe if different from $this->name
-
string|null$ext optional The name of the extension to make safe if different from $this->ext
Returns
stringThe extension of the file
size() ¶ public
size(): int|falseReturns the file size
Returns
int|falseSize of the file in bytes, or false in case of an error
writable() ¶ public
writable(): boolReturns true if the file is writable.
Returns
boolTrue if it's writable, false otherwise
write() ¶ public
write(string $data, string $mode = 'w', bool $force = false): boolWrite given data to this file.
Parameters
-
string$data Data to write to this File.
-
string$mode optional Mode of writing. {@link http://php.net/fwrite See fwrite()}.
-
bool$force optional Force the file to open
Returns
boolSuccess