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.3 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 1.3
      • 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
  • BakeTask
  • BehaviorCollection
  • Cache
  • CacheEngine
  • CacheHelper
  • CakeErrorController
  • CakeLog
  • CakeRoute
  • CakeSchema
  • CakeSession
  • CakeSocket
  • ClassRegistry
  • Component
  • Configure
  • ConnectionManager
  • ConsoleShell
  • ContainableBehavior
  • Controller
  • ControllerTask
  • CookieComponent
  • DataSource
  • DbAcl
  • DbConfigTask
  • DboMssql
  • DboMysql
  • DboMysqlBase
  • DboMysqli
  • DboOracle
  • DboPostgres
  • DboSource
  • DboSqlite
  • Debugger
  • EmailComponent
  • ErrorHandler
  • ExtractTask
  • File
  • FileEngine
  • FileLog
  • FixtureTask
  • Folder
  • FormHelper
  • Helper
  • HtmlHelper
  • HttpSocket
  • I18n
  • I18nModel
  • I18nShell
  • Inflector
  • IniAcl
  • JavascriptHelper
  • JqueryEngineHelper
  • JsBaseEngineHelper
  • JsHelper
  • L10n
  • MagicDb
  • MagicFileResource
  • MediaView
  • MemcacheEngine
  • Model
  • ModelBehavior
  • ModelTask
  • MootoolsEngineHelper
  • Multibyte
  • NumberHelper
  • Object
  • Overloadable
  • Overloadable2
  • PagesController
  • PaginatorHelper
  • Permission
  • PluginShortRoute
  • PluginTask
  • ProjectTask
  • PrototypeEngineHelper
  • RequestHandlerComponent
  • Router
  • RssHelper
  • Sanitize
  • Scaffold
  • ScaffoldView
  • SchemaShell
  • Security
  • SecurityComponent
  • SessionComponent
  • SessionHelper
  • Set
  • Shell
  • String
  • TemplateTask
  • TestSuiteShell
  • TestTask
  • TextHelper
  • ThemeView
  • TimeHelper
  • TranslateBehavior
  • TreeBehavior
  • Validation
  • View
  • ViewTask
  • XcacheEngine
  • Xml
  • XmlElement
  • XmlHelper
  • XmlManager
  • XmlNode
  • XmlTextNode

Functions

  • 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

Class TimeHelper

Time Helper class for easy use of time data.

Manipulation of time data.

Object
Extended by Overloadable
Extended by Helper
Extended by AppHelper
Extended by TimeHelper
Package: cake\cake\libs\view\helpers
Link: http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Time.html#Time
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: view/helpers/time.php

Inherited Properties

  • __cleaned, __tainted, action, argSeparator, base, data, helpers, here, namedArgs, params, plugin, tags, theme, validationErrors, webroot

Method Summary

  • __translateSpecifier() public

    Auxiliary function to translate a matched specifier element from a regular expresion into a windows safe and i18n aware specifier

  • _strftime() public
    Multibyte wrapper for strftime.
  • convert() public
    Converts given time (in server's time zone) to user's local time, given his/her offset from GMT.
  • convertSpecifiers() public

    Converts a string representing the format for the function strftime and returns a windows safe and i18n aware format.

  • dayAsSql() public

    Returns a partial SQL string to search for all records between two times occurring on the same day.

  • daysAsSql() public
    Returns a partial SQL string to search for all records between two dates.
  • format() public

    Returns a formatted date string, given either a UNIX timestamp or a valid strtotime() date string. This function also accepts a time string and a format string as first and second parameters. In that case this function behaves as a wrapper for TimeHelper::i18nFormat()

  • fromString() public
    Returns a UNIX timestamp, given either a UNIX timestamp or a valid strtotime() date string.
  • gmt() public
    Returns gmt, given either a UNIX timestamp or a valid strtotime() date string.
  • i18nFormat() public

    Returns a formatted date string, given either a UNIX timestamp or a valid strtotime() date string. It take in account the default date format for the current language if a LC_TIME file is used.

  • isThisMonth() public
    Returns true if given datetime string is within this month
  • isThisWeek() public
    Returns true if given datetime string is within this week
  • isThisYear() public
    Returns true if given datetime string is within current year.
  • isToday() public
    Returns true if given datetime string is today.
  • isTomorrow() public
    Returns true if given datetime string is tomorrow.
  • nice() public
    Returns a nicely formatted date string for given Datetime string.
  • niceShort() public
    Returns a formatted descriptive date string for given datetime string.
  • relativeTime() public deprecated
    Alias for timeAgoInWords
  • serverOffset() public
    Returns server's offset from GMT in seconds.
  • timeAgoInWords() public

    Returns either a relative date or a formatted date depending on the difference between the current time and given datetime. $datetime should be in a strtotime - parsable format, like MySQL's datetime datatype.

  • toAtom() public
    Returns a date formatted for Atom RSS feeds.
  • toQuarter() public
    Returns the quarter
  • toRSS() public
    Formats date for RSS feeds
  • toUnix() public
    Returns a UNIX timestamp from a textual datetime description. Wrapper for PHP function strtotime().
  • wasWithinLast() public
    Returns true if specified datetime was within the interval specified, else false.
  • wasYesterday() public
    Returns true if given datetime string was yesterday.

Method Detail

__translateSpecifier() public ¶

__translateSpecifier( array $specifier )

Auxiliary function to translate a matched specifier element from a regular expresion into a windows safe and i18n aware specifier

Parameters
array $specifier
match from regular expression
Returns
string
converted element

_strftime() public ¶

_strftime( string $format , integer $date )

Multibyte wrapper for strftime.

Handles utf8_encoding the result of strftime when necessary.

Parameters
string $format
Format string.
integer $date
Timestamp to format.
Returns
string
formatted string with correct encoding.

convert() public ¶

convert( string $serverTime , integer $userOffset )

Converts given time (in server's time zone) to user's local time, given his/her offset from GMT.

Parameters
string $serverTime
UNIX timestamp
integer $userOffset
User's offset from GMT (in hours)
Returns
string
UNIX timestamp

convertSpecifiers() public ¶

convertSpecifiers( string $format , string $time = null )

Converts a string representing the format for the function strftime and returns a windows safe and i18n aware format.

Parameters
string $format

Format with specifiers for strftime function. Accepts the special specifier %S which mimics th modifier S for date()

string $time optional null
timestamp
Returns
string
windows safe and date() function compatible format for strftime

dayAsSql() public ¶

dayAsSql( string $dateString , string $fieldName , integer $userOffset = null )

Returns a partial SQL string to search for all records between two times occurring on the same day.

Parameters
string $dateString
Datetime string or Unix timestamp
string $fieldName
Name of database field to compare with
integer $userOffset optional null
User's offset from GMT (in hours)
Returns
string
Partial SQL string.
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Time.html#Formatting

daysAsSql() public ¶

daysAsSql( string $begin , string $end , string $fieldName , integer $userOffset = null )

Returns a partial SQL string to search for all records between two dates.

Parameters
string $begin
$dateString Datetime string or Unix timestamp
string $end
Datetime string or Unix timestamp
string $fieldName
Name of database field to compare with
integer $userOffset optional null
User's offset from GMT (in hours)
Returns
string
Partial SQL string.
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Time.html#Formatting

format() public ¶

format( string $format , string $date = null , boolean $invalid = false , integer $userOffset = null )

Returns a formatted date string, given either a UNIX timestamp or a valid strtotime() date string. This function also accepts a time string and a format string as first and second parameters. In that case this function behaves as a wrapper for TimeHelper::i18nFormat()

Parameters
string $format
date format string (or a DateTime string)
string $date optional null
$dateString Datetime string (or a date format string)
boolean $invalid optional false
flag to ignore results of fromString == false
integer $userOffset optional null
User's offset from GMT (in hours)
Returns
string
Formatted date string

fromString() public ¶

fromString( string $dateString , integer $userOffset = null )

Returns a UNIX timestamp, given either a UNIX timestamp or a valid strtotime() date string.

Parameters
string $dateString
Datetime string
integer $userOffset optional null
User's offset from GMT (in hours)
Returns
string
Parsed timestamp
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Time.html#Formatting

gmt() public ¶

gmt( string $string = null )

Returns gmt, given either a UNIX timestamp or a valid strtotime() date string.

Parameters
string $string optional null
$dateString Datetime string
Returns
string
Formatted date string
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Time.html#Formatting

i18nFormat() public ¶

i18nFormat( string $date , string $format = null , boolean $invalid = false , integer $userOffset = null )

Returns a formatted date string, given either a UNIX timestamp or a valid strtotime() date string. It take in account the default date format for the current language if a LC_TIME file is used.

Parameters
string $date
$dateString Datetime string
string $format optional null
strftime format string.
boolean $invalid optional false
flag to ignore results of fromString == false
integer $userOffset optional null
User's offset from GMT (in hours)
Returns
string
Formatted and translated date string @access public

isThisMonth() public ¶

isThisMonth( string $dateString , integer $userOffset = null )

Returns true if given datetime string is within this month

Parameters
string $dateString
integer $userOffset optional null
User's offset from GMT (in hours)
Returns
boolean
True if datetime string is within current month
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Time.html#Testing-Time

isThisWeek() public ¶

isThisWeek( string $dateString , integer $userOffset = null )

Returns true if given datetime string is within this week

Parameters
string $dateString
integer $userOffset optional null
User's offset from GMT (in hours)
Returns
boolean
True if datetime string is within current week
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Time.html#Testing-Time

isThisYear() public ¶

isThisYear( string $dateString , $userOffset = null )

Returns true if given datetime string is within current year.

Parameters
string $dateString
Datetime string or Unix timestamp
$userOffset optional null
Returns
boolean
True if datetime string is within current year
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Time.html#Testing-Time

isToday() public ¶

isToday( string $dateString , integer $userOffset = null )

Returns true if given datetime string is today.

Parameters
string $dateString
Datetime string or Unix timestamp
integer $userOffset optional null
User's offset from GMT (in hours)
Returns
boolean
True if datetime string is today

isTomorrow() public ¶

isTomorrow( string $dateString , integer $userOffset = null )

Returns true if given datetime string is tomorrow.

Parameters
string $dateString
Datetime string or Unix timestamp
integer $userOffset optional null
User's offset from GMT (in hours)
Returns
boolean
True if datetime string was yesterday
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Time.html#Testing-Time

nice() public ¶

nice( string $dateString = null , integer $userOffset = null )

Returns a nicely formatted date string for given Datetime string.

Parameters
string $dateString optional null
Datetime string or Unix timestamp
integer $userOffset optional null
User's offset from GMT (in hours)
Returns
string
Formatted date string
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Time.html#Formatting

niceShort() public ¶

niceShort( string $dateString = null , integer $userOffset = null )

Returns a formatted descriptive date string for given datetime string.

If the given date is today, the returned string could be "Today, 16:54". If the given date was yesterday, the returned string could be "Yesterday, 16:54". If $dateString's year is the current year, the returned string does not include mention of the year.

Parameters
string $dateString optional null
Datetime string or Unix timestamp
integer $userOffset optional null
User's offset from GMT (in hours)
Returns
string
Described, relative date string
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Time.html#Formatting

relativeTime() public deprecated ¶

relativeTime( mixed $dateTime , mixed $options = array() )

Alias for timeAgoInWords

Deprecated
This method alias will be removed in future versions.
Parameters
mixed $dateTime
Datetime string (strtotime-compatible) or Unix timestamp
mixed $options optional array()

Default format string, if timestamp is used in $dateTime, or an array of options to be passed on to timeAgoInWords().

Returns
string
Relative time string.
See
TimeHelper::timeAgoInWords
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Time.html#Formatting

serverOffset() public ¶

serverOffset( )

Returns server's offset from GMT in seconds.

Returns
integer
Offset

timeAgoInWords() public ¶

timeAgoInWords( string $dateTime , array $options = array() )

Returns either a relative date or a formatted date depending on the difference between the current time and given datetime. $datetime should be in a strtotime - parsable format, like MySQL's datetime datatype.

Options:

  • format => a fall back format if the relative time is longer than the duration specified by end
  • end => The end of relative time telling
  • userOffset => Users offset from GMT (in hours)

Relative dates look something like this: 3 weeks, 4 days ago 15 seconds ago

Default date formatting is d/m/yy e.g: on 18/2/09

The returned string includes 'ago' or 'on' and assumes you'll properly add a word like 'Posted ' before the function output.

Parameters
string $dateTime
$dateString Datetime string or Unix timestamp
array $options optional array()
Default format if timestamp is used in $dateString
Returns
string
Relative time string.
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Time.html#Formatting

toAtom() public ¶

toAtom( string $dateString , integer $userOffset = null )

Returns a date formatted for Atom RSS feeds.

Parameters
string $dateString
Datetime string or Unix timestamp
integer $userOffset optional null
User's offset from GMT (in hours)
Returns
string
Formatted date string
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Time.html#Formatting

toQuarter() public ¶

toQuarter( string $dateString , boolean $range = false )

Returns the quarter

Parameters
string $dateString
boolean $range optional false
if true returns a range in Y-m-d format
Returns
boolean
True if datetime string is within current week
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Time.html#Formatting

toRSS() public ¶

toRSS( string $dateString , integer $userOffset = null )

Formats date for RSS feeds

Parameters
string $dateString
Datetime string or Unix timestamp
integer $userOffset optional null
User's offset from GMT (in hours)
Returns
string
Formatted date string
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Time.html#Formatting

toUnix() public ¶

toUnix( string $dateString , integer $userOffset = null )

Returns a UNIX timestamp from a textual datetime description. Wrapper for PHP function strtotime().

Parameters
string $dateString
Datetime string to be represented as a Unix timestamp
integer $userOffset optional null
User's offset from GMT (in hours)
Returns
integer
Unix timestamp
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Time.html#Formatting

wasWithinLast() public ¶

wasWithinLast( mixed $timeInterval , mixed $dateString , integer $userOffset = null )

Returns true if specified datetime was within the interval specified, else false.

Parameters
mixed $timeInterval

the numeric value with space then time type. Example of valid types: 6 hours, 2 days, 1 minute.

mixed $dateString
the datestring or unix timestamp to compare
integer $userOffset optional null
User's offset from GMT (in hours)
Returns
boolean
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Time.html#Testing-Time

wasYesterday() public ¶

wasYesterday( string $dateString , integer $userOffset = null )

Returns true if given datetime string was yesterday.

Parameters
string $dateString
Datetime string or Unix timestamp
integer $userOffset optional null
User's offset from GMT (in hours)
Returns
boolean
True if datetime string was yesterday
Link
http://book.cakephp.org/1.3/en/The-Manual/Core-Helpers/Time.html#Testing-Time

Methods inherited from Helper

__clean() public ¶

__clean( )

Removes harmful content from output

__formatAttribute() public ¶

__formatAttribute( string $key , string $value , $escape = true )

Formats an individual attribute, and returns the string value of the composed attribute. Works with minimized attributes that have the same value as their name such as 'disabled' and 'checked'

Parameters
string $key
The name of the attribute to create
string $value
The value of the attribute to create.
$escape optional true
Returns
string
The composed attribute.

__reset() public ¶

__reset( )

Resets the vars used by Helper::clean() to null

__selectedArray() public ¶

__selectedArray( mixed $data , string $key = 'id' )

Transforms a recordset from a hasAndBelongsToMany association to a list of selected options for a multiple select element

Parameters
mixed $data
string $key optional 'id'
Returns
array

_initInputField() public ¶

_initInputField( string $field , array $options = array() )

Sets the defaults for an input tag. Will set the name, value, and id attributes for an array of html attributes. Will also add a 'form-error' class if the field contains validation errors.

Parameters
string $field
The field name to initialize.
array $options optional array()
Array of options to use while initializing an input field.
Returns
array
Array options for the form input.

_name() public ¶

_name( mixed $options = array() , string $field = null , string $key = 'name' )

Gets the input field name for the current tag. Creates input name attributes using CakePHP's data[Model][field] formatting.

Parameters
mixed $options optional array()

If an array, should be an array of attributes that $key needs to be added to. If a string or null, will be used as the View entity.

string $field optional null
string $key optional 'name'
The name of the attribute to be set, defaults to 'name'
Returns
mixed

If an array was given for $options, an array with $key set will be returned. If a string was supplied a string will be returned.


_parseAttributes() public ¶

_parseAttributes( array $options , array $exclude = null , string $insertBefore = ' ' , string $insertAfter = null )

Returns a space-delimited string with items of the $options array. If a key of $options array happens to be one of:

  • 'compact'
  • 'checked'
  • 'declare'
  • 'readonly'
  • 'disabled'
  • 'selected'
  • 'defer'
  • 'ismap'
  • 'nohref'
  • 'noshade'
  • 'nowrap'
  • 'multiple'
  • 'noresize'

And its value is one of:

  • '1' (string)
  • 1 (integer)
  • true (boolean)
  • 'true' (string)

Then the value will be reset to be identical with key's name. If the value is not one of these 3, the parameter is not output.

'escape' is a special option in that it controls the conversion of attributes to their html-entity encoded equivalents. Set to false to disable html-encoding.

If value for any option key is set to null or false, that option will be excluded from output.

Parameters
array $options
Array of options.
array $exclude optional null
Array of options to be excluded, the options here will not be part of the return.
string $insertBefore optional ' '
String to be inserted before options.
string $insertAfter optional null
String to be inserted after options.
Returns
string
Composed attributes.

addClass() public ¶

addClass( array $options = array() , string $class = null , string $key = 'class' )

Adds the given class to the element options

Parameters
array $options optional array()
Array options/attributes to add a class to
string $class optional null
The classname being added.
string $key optional 'class'
the key to use for class.
Returns
array
Array of options with $key set.

afterLayout() public ¶

afterLayout( )

After layout callback. afterLayout is called after the layout has rendered.

Overridden in subclasses.

afterRender() public ¶

afterRender( )

After render callback. afterRender is called after the view file is rendered but before the layout has been rendered.

Overridden in subclasses.

assetTimestamp() public ¶

assetTimestamp( string $path )

Adds a timestamp to a file based resource based on the value of Asset.timestamp in Configure. If Asset.timestamp is true and debug > 0, or Asset.timestamp == 'force' a timestamp will be added.

Parameters
string $path
The file path to timestamp, the path must be inside WWW_ROOT
Returns
string
Path with a timestamp added, or not.

beforeLayout() public ¶

beforeLayout( )

Before layout callback. beforeLayout is called before the layout is rendered.

Overridden in subclasses.

beforeRender() public ¶

beforeRender( )

Before render callback. beforeRender is called before the view file is rendered.

Overridden in subclasses.

call__() public ¶

call__( $method , $params )

clean() public ¶

clean( mixed $output )

Used to remove harmful tags from content. Removes a number of well known XSS attacks from content. However, is not guaranteed to remove all possiblities. Escaping content is the best way to prevent all possible attacks.

Parameters
mixed $output
Either an array of strings to clean or a single string to clean.
Returns
cleaned
content for output

domId() public ¶

domId( mixed $options = null , string $id = 'id' )

Generates a DOM ID for the selected element, if one is not set. Uses the current View::entity() settings to generate a CamelCased id attribute.

Parameters
mixed $options optional null

Either an array of html attributes to add $id into, or a string with a view entity path to get a domId for.

string $id optional 'id'
The name of the 'id' attribute.
Returns
mixed

If $options was an array, an array will be returned with $id set. If a string was supplied, a string will be returned.


field() public ¶

field( )

Gets the currently-used model field of the rendering context.

Returns
string

get__() public ¶

get__( $name )

Default overload methods

loadConfig() public ¶

loadConfig( $name = 'tags' )

Parses tag templates into $this->tags.

Parameters
$name optional 'tags'
name inside app/config to load.
Returns
array
merged tags from config/$name.php

model() public ¶

model( )

Gets the currently-used model of the rendering context.

Returns
string

modelID() public ¶

modelID( )

Gets the ID of the currently-used model of the rendering context.

Returns
mixed

output() public deprecated ¶

output( string $str )

Returns a string generated by a helper method

This method can be overridden in subclasses to do generalized output post-processing

Deprecated
This method will be removed in future versions.
Parameters
string $str
String to be output.
Returns
string

setEntity() public ¶

setEntity( mixed $entity , boolean $setScope = false )

Sets this helper's model and field properties to the dot-separated value-pair in $entity.

Parameters
mixed $entity
A field name, like "ModelName.fieldName" or "ModelName.ID.fieldName"
boolean $setScope optional false
Sets the view scope to the model specified in $tagValue

set__() public ¶

set__( $name , $value )

tagIsInvalid() public ¶

tagIsInvalid( string $model = null , string $field = null , integer $modelID = null )

Returns null if given FORM field has no errors. Otherwise it returns the constant set in the array Model->validationErrors.

Parameters
string $model optional null
Model name as a string
string $field optional null
Fieldname as a string
integer $modelID optional null
Unique index identifying this record within the form
Returns
mixed
Null if no errors, string with error otherwhise.

url() public ¶

url( mixed $url = null , boolean $full = false )

Finds URL for specified action.

Returns a URL pointing at the provided parameters.

Parameters
mixed $url optional null

Either a relative string url like /products/view/23 or an array of url parameters. Using an array for urls will allow you to leverage the reverse routing features of CakePHP.

boolean $full optional false
If true, the full base URL will be prepended to the result
Returns
string
Full translated URL with base path.
Link
http://book.cakephp.org/view/1448/url

value() public ¶

value( mixed $options = array() , string $field = null , string $key = 'value' )

Gets the data for the current tag

Parameters
mixed $options optional array()

If an array, should be an array of attributes that $key needs to be added to. If a string or null, will be used as the View entity.

string $field optional null
string $key optional 'value'
The name of the attribute to be set, defaults to 'value'
Returns
mixed

If an array was given for $options, an array with $key set will be returned. If a string was supplied a string will be returned.


webroot() public ¶

webroot( string $file )

Checks if a file exists when theme is used, if no file is found default location is returned

Parameters
string $file
The file to create a webroot path to.
Returns
string
Web accessible path to file.

Methods inherited from Overloadable

__call() public ¶

__call( string $method , array $params )

Magic method handler.

Parameters
string $method
Method name
array $params
Parameters to send to method
Returns
mixed
Return value from method

overload() public ¶

overload( )

Overload implementation. No need for implementation in PHP5.

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

__construct() public ¶

__construct( )

Class constructor, overridden in descendant classes.

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