Class File

Convenience class for reading, writing and appending to files.

Object

File

Package: cake\cake\libs
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: file.php

Properties summary

$Folder public

Folder

Folder object of the File
$handle public

resource

Holds the file handler resource if the file is opened
$info public

string

file info
$lock public

boolean

enable locking for file reading and writing
$name public

string

Filename
$path public

mixed

path property

Method Summary

Folder() public

Returns the current folder.
__construct() public

Constructor
__destruct() public

Closes the current file if it is opened
append() public

Append given data string to this File.
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.
group() public

Returns the File's group.
info() public

Returns the File info.
lastAccess() public

Returns last access time.
lastChange() public

Returns last modified time.
md5() public

Get md5 Checksum of file with previous check of Filesize
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

Prepares a 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.
safe() public

makes filename safe for saving
size() public

Returns the Filesize
writable() public

Returns true if the File is writable.
write() public

Write given data to this File.

Method Detail

Folder() public ¶

Folder( )

Returns the current folder.

Returns

Folder
Current folder

__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

Overrides

Object::__construct()

__destruct() public ¶

__destruct( )

Closes the current file if it is opened

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

boolean
Success

close() public ¶

close( )

Closes the current file if it is opened.

Returns

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

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

boolean
Succes

create() public ¶

create( )

Creates the File.

Returns

boolean
Success

delete() public ¶

delete( )

Deletes the File.

Returns

boolean
Success

executable() public ¶

executable( )

Returns true if the File is executable.

Returns

boolean
true if its executable, false otherwise

exists() public ¶

exists( )

Returns true if the File exists.

Returns

boolean
true if it exists, false otherwise

ext() public ¶

ext( )

Returns the File extension.

Returns

string
The File extension

group() public ¶

group( )

Returns the File's group.

Returns

integer
the Filegroup

info() public ¶

info( )

Returns the File info.

Returns

string
The File extension

lastAccess() public ¶

lastAccess( )

Returns last access time.

Returns

integer
timestamp Timestamp of last access time

lastChange() public ¶

lastChange( )

Returns last modified time.

Returns

integer
timestamp Timestamp of last modification

md5() public ¶

md5( mixed $maxsize = 5 )

Get md5 Checksum of file with previous check of Filesize

Parameters

mixed $maxsize optional 5: in MB or true to force

Returns

string
md5 Checksum See md5_file()

name() public ¶

name( )

Returns the File name without extension.

Returns

string
The File name without extension.

offset() public ¶

offset( mixed $offset = false , integer $seek = SEEK_SET )

Sets or gets the offset for the currently opened file.

Parameters

mixed $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

mixed
True on success, false on failure (set mode), false on failure or integer offset on success (get mode)

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

boolean
True on success, false on failure

owner() public ¶

owner( )

Returns the File's owner.

Returns

integer
the Fileowner

perms() public ¶

perms( )

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

Returns

string
Permissions for the file

prepare() public ¶

prepare( string $data , $forceWindows = false )

Prepares a 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.
$forceWindows optional false

Returns

string
The with converted line endings.

pwd() public ¶

pwd( )

Returns the full path of the File.

Returns

string
Full path to file

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

mixed
string on success, false on failure

readable() public ¶

readable( )

Returns true if the File is readable.

Returns

boolean
true if file is readable, false otherwise

safe() public ¶

safe( string $name = null , strin $ext = null )

makes filename safe for saving

Parameters

string $name optional null: The name of the file to make safe if different from $this->name
strin $ext optional null: The name of the extension to make safe if different from $this->ext

Returns

string
$ext the extension of the file

size() public ¶

size( )

Returns the Filesize

Returns

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

writable() public ¶

writable( )

Returns true if the File is writable.

Returns

boolean
true if its writable, false otherwise

write() public ¶

write( string $data , string $mode = 'w' , string $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().
string $force optional false: force the file to open

Returns

boolean
Success

Methods inherited from Object

Object() public ¶

Object( )

A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()

Returns

Object

__openPersistent() public ¶

__openPersistent( string $name , string $type = null )

Open the persistent class file for reading Used by Object::_persist()

Parameters

string $name: Name of persisted class
string $type optional null: Type of persistance (e.g: registry)

_persist() public ¶

_persist( string $name , string $return , $object , $type = null )

Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples

Parameters

string $name: name of the class to persist
string $return: $object the object to persist
$object
$type optional null

Returns

boolean
Success

_savePersistent() public ¶

_savePersistent( string $name , object $object )

You should choose a unique name for the persistent file

There are many uses for this method, see manual for examples

Parameters

string $name: name used for object to cache
object $object: the object to persist

Returns

boolean
true on save, throws error if file can not be created

_set() public ¶

_set( array $properties = array() )

Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.

Parameters

array $properties optional array(): An associative array containing properties and corresponding values.

_stop() public ¶

_stop( $status = 0 )

Stop execution of the current script. Wraps exit() making testing easier.

Parameters

$status optional 0: http://php.net/exit for values

cakeError() public ¶

cakeError( string $method , array $messages = array() )

Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.

Parameters

string $method: Method to be called in the error class (AppError or ErrorHandler classes)
array $messages optional array(): Message that is to be displayed by the error class

Returns

error
message

dispatchMethod() public ¶

dispatchMethod( string $method , array $params = array() )

Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array

Parameters

string $method: Name of the method to call
array $params optional array(): Parameter list to use when calling $method

Returns

mixed
Returns the result of the method call

log() public ¶

log( string $msg , integer $type = LOG_ERROR )

Convience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.

Parameters

string $msg: Log message
integer $type optional LOG_ERROR: Error type constant. Defined in app/config/core.php.

Returns

boolean
Success of log write

requestAction() public ¶

requestAction( mixed $url , array $extra = array() )

Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.

Parameters

mixed $url: String or array-based url.
array $extra optional array(): if array includes the key "return" it sets the AutoRender to true.

Returns

mixed

Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.

toString() public ¶

toString( )

Object-to-string conversion. Each class can override this method as necessary.

Returns

string
The name of this class

Properties detail

`$Folder` ¶

public Folder

Folder object of the File

null

`$handle` ¶

public resource

Holds the file handler resource if the file is opened

null

`$info` ¶

public string

file info

array()

`$lock` ¶

public boolean

enable locking for file reading and writing

null

`$name` ¶

public string

Filename

null

`$path` ¶

public mixed

path property

Current file's absolute path

null

Classes

Functions

Class File

Properties summary

Method Summary

Folder() public

__construct() public

__destruct() public

append() public

close() public

copy() public

create() public

delete() public

executable() public

exists() public

ext() public

group() public

info() public

lastAccess() public

lastChange() public

md5() public

name() public

offset() public

open() public

owner() public

perms() public

prepare() public

pwd() public

read() public

readable() public

safe() public

size() public

writable() public

write() public

Method Detail

Folder() public ¶

Returns

__construct() public ¶

Parameters

Overrides

__destruct() public ¶

append() public ¶

Parameters

Returns

close() public ¶

Returns

copy() public ¶

Parameters

Returns

create() public ¶

Returns

delete() public ¶

Returns

executable() public ¶

Returns

exists() public ¶

Returns

ext() public ¶

Returns

group() public ¶

Returns

info() public ¶

Returns

lastAccess() public ¶

Returns

lastChange() public ¶

Returns

md5() public ¶

Parameters

Returns

name() public ¶

Returns

offset() public ¶

Parameters

Returns

open() public ¶

Parameters

Returns

owner() public ¶

Returns

`$Folder` ¶

`$handle` ¶

`$info` ¶

`$lock` ¶

`$name` ¶

`$path` ¶