Class File
Convenience class for reading, writing and appending to files.
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/Utility/File.php
Properties 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 , 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
append() public ¶
append( string $data , string $force = false )
Append given data string to this file.
Parameters
- string $data
- Data to write
- string $force optional false
- Force the file to open
Returns
Success
Link
clearStatCache() public ¶
clearStatCache( boolean $all = false )
Clear PHP's internal stat cache
For 5.3 onwards it's possible to clear cache for just a single file. Passing true will clear all the stat cache.
Parameters
- boolean $all optional false
- Clear all cache or not
close() public ¶
close( )
Closes the current file if it is opened.
Returns
True if closing was successful or file was already closed, otherwise false
Link
copy() 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
Success
Link
executable() public ¶
executable( )
Returns true if the File is executable.
Returns
True if it's executable, false otherwise
Link
exists() public ¶
exists( )
Returns true if the file exists.
Returns
True if it exists, false otherwise
Link
group() public ¶
group( )
Returns the file's group.
Returns
The file group, or false in case of an error
Link
info() public ¶
info( )
Returns the file info as an array with the following keys:
- dirname
- basename
- extension
- filename
- filesize
- mime
Returns
File information.
Link
lastAccess() public ¶
lastAccess( )
Returns last access time.
Returns
Timestamp of last access time, or false in case of an error
Link
lastChange() public ¶
lastChange( )
Returns last modified time.
Returns
Timestamp of last modification, or false in case of an error
Link
md5() 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
Link
mime() public ¶
mime( )
Get the mime type of the file. Uses the finfo extension if its available, otherwise falls back to mime_content_type
Returns
The mimetype of the file, or false if reading fails.
name() public ¶
name( )
Returns the file name without extension.
Returns
The file name without extension.
Link
offset() 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
True on success, false on failure (set mode), false on failure or integer offset on success (get mode)
Link
open() 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
True on success, false on failure
Link
owner() public ¶
owner( )
Returns the file's owner.
Returns
The file owner, or false in case of an error
Link
perms() public ¶
perms( )
Returns the "chmod" (permissions) of the file.
Returns
Permissions for the file, or false in case of an error
Link
prepare() 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 usage Windows newline string.
Returns
The with converted line endings.
Link
read() public ¶
read( string $bytes = false , string $mode = 'rb' , boolean $force = false )
Return the contents of this file as a string.
Parameters
- string $bytes optional false
- where to start
- string $mode optional 'rb'
- A
freadcompatible 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 on success, false on failure
Link
readable() public ¶
readable( )
Returns true if the file is readable.
Returns
True if file is readable, false otherwise
Link
replaceText() 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
Success
safe() public ¶
safe( string $name = null , string $ext = null )
Makes file name safe for saving
Parameters
- string $name optional null
- The name of the file to make safe if different from $this->name
- string $ext optional null
- The name of the extension to make safe if different from $this->ext
Returns
ext The extension of the file
Link
size() public ¶
size( )
Returns the file size
Returns
Size of the file in bytes, or false in case of an error
Link
writable() public ¶
writable( )
Returns true if the file is writable.
Returns
True if it's writable, false otherwise
Link
write() 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
Success