Class File

Convenience class for reading, writing and appending to files.

Namespace: Cake\Filesystem
Located at Filesystem/File.php

Method Detail

__constructsource 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-api

__destructsource public

__destruct( )

Closes the current file if it is opened

appendsource 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

boolean
Success

clearStatCachesource 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.

closesource public

close( )

Closes the current file if it is opened.

Returns

boolean
True if closing was successful or file was already closed, otherwise false

copysource 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

boolean
Success

createsource public

create( )

Creates the file.

Returns

boolean
Success

deletesource public

delete( )

Deletes the file.

Returns

boolean
Success

executablesource public

executable( )

Returns true if the File is executable.

Returns

boolean
True if it's executable, false otherwise

existssource public

exists( )

Returns true if the file exists.

Returns

boolean
True if it exists, false otherwise

extsource public

ext( )

Returns the file extension.

Returns

string|false
The file extension, false if extension cannot be extracted.

foldersource public

folder( )

Returns the current folder.

Returns

Cake\Filesystem\Folder
Current folder

groupsource public

group( )

Returns the file's group.

Returns

integer|false
The file group, or false in case of an error

infosource public

info( )

Returns the file info as an array with the following keys:

dirname
basename
extension
filename
filesize
mime

Returns

array
File information.

lastAccesssource public

lastAccess( )

Returns last access time.

Returns

integer|false
Timestamp of last access time, or false in case of an error

lastChangesource public

lastChange( )

Returns last modified time.

Returns

integer|false
Timestamp of last modification, or false in case of an error

md5source 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|false
md5 Checksum See md5_file(), or false in case of an error

mimesource 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|string
The mimetype of the file, or false if reading fails.

namesource public

name( )

Returns the file name without extension.

Returns

string|false
The file name without extension, false if name cannot be extracted.

offsetsource 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|boolean
True on success, false on failure (set mode), false on failure or integer offset on success (get mode)

opensource 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

boolean
True on success, false on failure

ownersource public

owner( )

Returns the file's owner.

Returns

integer|false
The file owner, or false in case of an error

permssource public

perms( )

Returns the "chmod" (permissions) of the file.

Returns

string|false
Permissions for the file, or false in case of an error

preparesource 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

string
The with converted line endings.

pwdsource public

pwd( )

Returns the full path of the file.

Returns

string
Full path to the file

readsource 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|false
string on success, false on failure

readablesource public

readable( )

Returns true if the file is readable.

Returns

boolean
True if file is readable, false otherwise

replaceTextsource 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

boolean
Success

safesource 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

string
The extension of the file

sizesource public

size( )

Returns the file size

Returns

integer|false
Size of the file in bytes, or false in case of an error

writablesource public

writable( )

Returns true if the file is writable.

Returns

boolean
True if it's writable, false otherwise

writesource 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

boolean
Success

Properties summary

$Foldersource

public Cake\Filesystem\Folder

Folder object of the file

Link

http://book.cakephp.org/3.0/en/core-libraries/file-folder.html

null

$handlesource

public resource

Holds the file handler resource if the file is opened

null

$infosource

public array

File info

[]

$locksource

public boolean

Enable locking for file reading and writing

null

$namesource

public string

File name

null

$pathsource

public mixed

Path property

Current file's absolute path

null

© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Filesystem.File.html