File (class)
Class File
Convenience class for reading, writing and appending to files.
Properties summary
-
$Folder
public -
$handle
publicHolds the file handler resource if the file is openedresource
-
$info
publicFile infoarray
-
$lock
publicEnable locking for file reading and writingboolean
-
$name
publicFile namestring
-
$path
publicPath propertymixed
Method Summary
- __construct() publicConstructor
- __destruct() publicCloses the current file if it is opened
- append() publicAppend given data string to this file.
- clearStatCache() publicClear PHP's internal stat cache
- close() publicCloses the current file if it is opened.
- copy() publicCopy the File to $dest
- create() publicCreates the file.
- delete() publicDeletes the file.
- executable() publicReturns true if the File is executable.
- exists() publicReturns true if the file exists.
- ext() publicReturns the file extension.
- folder() publicReturns the current folder.
- group() publicReturns the file's group.
- info() publicReturns the file info as an array with the following keys:
- lastAccess() publicReturns last access time.
- lastChange() publicReturns last modified time.
- md5() publicGet 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() publicReturns the file name without extension.
- offset() publicSets or gets the offset for the currently opened file.
- open() publicOpens the current file with a given $mode
- owner() publicReturns the file's owner.
- perms() publicReturns the "chmod" (permissions) of the file.
-
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() publicReturns the full path of the file.
- read() publicReturn the contents of this file as a string.
- readable() publicReturns true if the file is readable.
- replaceText() publicSearches for a given text and replaces the text if found.
- safe() publicMakes file name safe for saving
- size() publicReturns the file size
- writable() publicReturns true if the file is writable.
- write() publicWrite given data to this file.
Method Detail
__construct()source public
__construct( string $path , boolean $create false , integer $mode 0755 )
Constructor
Parameters
- string
$path
- Path to file
- boolean
$create
optional false - Create file if it does not exist (if true)
- integer
$mode
optional 0755 - Mode to apply to the folder holding the file
Link
http://book.cakephp.org/3.0/en/core-libraries/file-folder.html#file-apiappend()source public
append( string $data , boolean $force false )
Append given data string to this file.
Parameters
- string
$data
- Data to write
- boolean
$force
optional false - Force the file to open
Returns
booleanSuccess
clearStatCache()source public
clearStatCache( boolean $all false )
Clear PHP's internal stat cache
Parameters
- boolean
$all
optional false Clear all cache or not. Passing false will clear the stat cache for the current path only.
close()source public
close( )
Closes the current file if it is opened.
Returns
booleanTrue if closing was successful or file was already closed, otherwise false
copy()source public
copy( string $dest , boolean $overwrite true )
Copy the File to $dest
Parameters
- string
$dest
- Destination for the copy
- boolean
$overwrite
optional true - Overwrite $dest if exists
Returns
booleanSuccess
executable()source public
executable( )
Returns true if the File is executable.
Returns
booleanTrue if it's executable, false otherwise
exists()source public
exists( )
Returns true if the file exists.
Returns
booleanTrue if it exists, false otherwise
ext()source public
ext( )
Returns the file extension.
Returns
string|falseThe file extension, false if extension cannot be extracted.
folder()source public
folder( )
Returns the current folder.
Returns
Cake\Filesystem\Folder
Current folder
group()source public
group( )
Returns the file's group.
Returns
integer|falseThe file group, or false in case of an error
info()source public
info( )
Returns the file info as an array with the following keys:
- dirname
- basename
- extension
- filename
- filesize
- mime
Returns
arrayFile information.
lastAccess()source public
lastAccess( )
Returns last access time.
Returns
integer|falseTimestamp of last access time, or false in case of an error
lastChange()source public
lastChange( )
Returns last modified time.
Returns
integer|falseTimestamp of last modification, or false in case of an error
md5()source public
md5( integer|boolean $maxsize 5 )
Get md5 Checksum of file with previous check of Filesize
Parameters
- integer|boolean
$maxsize
optional 5 - in MB or true to force
Returns
string|falsemd5 Checksum See md5_file(), or false in case of an error
mime()source public
mime( )
Get 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()source public
name( )
Returns the file name without extension.
Returns
string|falseThe file name without extension, false if name cannot be extracted.
offset()source public
offset( integer|boolean $offset false , integer $seek SEEK_SET )
Sets or gets the offset for the currently opened file.
Parameters
- integer|boolean
$offset
optional false - The $offset in bytes to seek. If set to false then the current offset is returned.
- integer
$seek
optional SEEK_SET - PHP Constant SEEK_SET | SEEK_CUR | SEEK_END determining what the $offset is relative to
Returns
integer|booleanTrue on success, false on failure (set mode), false on failure or integer offset on success (get mode)
open()source public
open( string $mode 'r' , boolean $force false )
Opens the current file with a given $mode
Parameters
- string
$mode
optional 'r' - A valid 'fopen' mode string (r|w|a ...)
- boolean
$force
optional false - If true then the file will be re-opened even if its already opened, otherwise it won't
Returns
booleanTrue on success, false on failure
owner()source public
owner( )
Returns the file's owner.
Returns
integer|falseThe file owner, or false in case of an error
perms()source public
perms( )
Returns the "chmod" (permissions) of the file.
Returns
string|falsePermissions for the file, or false in case of an error
prepare()source public static
prepare( string $data , boolean $forceWindows false )
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"
Parameters
- string
$data
- Data to prepare for writing.
- boolean
$forceWindows
optional false - If true forces Windows new line string.
Returns
stringThe with converted line endings.
read()source public
read( string|boolean $bytes false , string $mode 'rb' , boolean $force false )
Return the contents of this file as a string.
Parameters
- string|boolean
$bytes
optional false - where to start
- string
$mode
optional 'rb' - A
fread
compatible mode. - boolean
$force
optional false - 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()source public
readable( )
Returns true if the file is readable.
Returns
booleanTrue if file is readable, false otherwise
replaceText()source public
replaceText( string|array $search , string|array $replace )
Searches 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
booleanSuccess
safe()source public
safe( string|null $name null , string|null $ext null )
Makes file name safe for saving
Parameters
- string|null
$name
optional null - The name of the file to make safe if different from $this->name
- string|null
$ext
optional null - The name of the extension to make safe if different from $this->ext
Returns
stringThe extension of the file
size()source public
size( )
Returns the file size
Returns
integer|falseSize of the file in bytes, or false in case of an error
writable()source public
writable( )
Returns true if the file is writable.
Returns
booleanTrue if it's writable, false otherwise
write()source public
write( string $data , string $mode 'w' , boolean $force false )
Write given data to this file.
Parameters
- string
$data
- Data to write to this File.
- string
$mode
optional 'w' - Mode of writing. See fwrite().
- boolean
$force
optional false - Force the file to open
Returns
booleanSuccess
Properties detail
$Foldersource
public Cake\Filesystem\Folder
Folder object of the file
Link
http://book.cakephp.org/3.0/en/core-libraries/file-folder.htmlnull
© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.3/class-Cake.Filesystem.File.html