CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (GitHub)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • Slack
    • Paid Support
CakePHP

C CakePHP 1.2 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 1.2
      • 4.2
      • 4.1
      • 4.0
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Classes

  • AclBase
  • AclBehavior
  • AclComponent
  • AclNode
  • AclShell
  • Aco
  • AcoAction
  • AjaxHelper
  • ApcEngine
  • ApiShell
  • App
  • AppController
  • AppHelper
  • AppModel
  • Aro
  • AuthComponent
  • BakeShell
  • BehaviorCollection
  • Cache
  • CacheEngine
  • CacheHelper
  • CakeErrorController
  • CakeLog
  • CakeSchema
  • CakeSession
  • CakeSocket
  • ClassRegistry
  • Component
  • Configure
  • ConnectionManager
  • ConsoleShell
  • ContainableBehavior
  • Controller
  • ControllerTask
  • CookieComponent
  • DataSource
  • DbAcl
  • DbAclSchema
  • DbConfigTask
  • DboAdodb
  • DboDb2
  • DboFirebird
  • DboMssql
  • DboMysql
  • DboMysqlBase
  • DboMysqli
  • DboOdbc
  • DboOracle
  • DboPostgres
  • DboSource
  • DboSqlite
  • DboSybase
  • Debugger
  • EmailComponent
  • ErrorHandler
  • ExtractTask
  • File
  • FileEngine
  • Flay
  • Folder
  • FormHelper
  • Helper
  • HtmlHelper
  • HttpSocket
  • I18n
  • I18nModel
  • i18nSchema
  • I18nShell
  • Inflector
  • IniAcl
  • JavascriptHelper
  • JsHelper
  • JsHelperObject
  • L10n
  • MagicDb
  • MagicFileResource
  • MediaView
  • MemcacheEngine
  • Model
  • ModelBehavior
  • ModelTask
  • Multibyte
  • NumberHelper
  • Object
  • Overloadable
  • Overloadable2
  • PagesController
  • PaginatorHelper
  • Permission
  • PluginTask
  • ProjectTask
  • RequestHandlerComponent
  • Router
  • RssHelper
  • Sanitize
  • Scaffold
  • ScaffoldView
  • SchemaShell
  • Security
  • SecurityComponent
  • SessionComponent
  • SessionHelper
  • SessionsSchema
  • Set
  • Shell
  • String
  • TestSuiteShell
  • TestTask
  • TextHelper
  • ThemeView
  • TimeHelper
  • TranslateBehavior
  • TreeBehavior
  • Validation
  • View
  • ViewTask
  • XcacheEngine
  • Xml
  • XmlElement
  • XmlHelper
  • XmlManager
  • XmlNode
  • XmlTextNode

Functions

  • __enclose
  • make_clean_css
  • mb_encode_mimeheader
  • mb_stripos
  • mb_stristr
  • mb_strlen
  • mb_strpos
  • mb_strrchr
  • mb_strrichr
  • mb_strripos
  • mb_strrpos
  • mb_strstr
  • mb_strtolower
  • mb_strtoupper
  • mb_substr
  • mb_substr_count
  • write_css_cache

Class File

Convenience class for reading, writing and appending to files.

Object
Extended by File
Package: cake\cake\libs
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: The MIT License
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

Inherited Properties

  • _log

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.
  • 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 group.
  • info() public
    Returns the File extension.
  • 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 fixes line endings

  • 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

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

Returns
integer
the Filegroup

info() public ¶

info( )

Returns the File extension.

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 fixes line endings

Parameters
string $data
Data to prepare for writing.
$forceWindows optional false
Returns
string

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'
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 , $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
$ext optional null
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.

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

_stop() public ¶

_stop( $status = 0 )

Stop execution of the current script

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, and improves performance by using straight method calls in most cases.

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 )

API for logging events.

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.

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
OpenHub
Rackspace
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (GitHub)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • Slack
  • Paid Support

Generated using CakePHP API Docs