Class TimeHelper

__callsource public

__call( string $method , array $params )

Call methods from CakeTime utility class

Parameters

string $method

Method to call.

array $params

Parameters to pass to method.

Returns

mixed
Whatever is returned by called method, or false on failure

Overrides

Helper::__call()

__constructsource public

__construct( View $View , array $settings array() )

Constructor

Settings:

• engine Class name to use to replace CakeTime functionality The class needs to be placed in the Utility directory.

Parameters

View $View

the view object the helper is attached to.

array $settings optional array()

Settings array

Throws

CakeException
When the engine class could not be found.

Overrides

Helper::__construct()

__getsource public

__get( string $name )

Magic accessor for attributes that were deprecated.

Parameters

string $name

Name of the attribute to get.

Returns

mixed
mixed

Overrides

Helper::__get()

__issetsource public

__isset( string $name )

Magic isset check for deprecated attributes.

Parameters

string $name

Name of the attribute to check.

Returns

boolean|null
bool|null

__setsource public

__set( string $name , string $value )

Magic accessor for deprecated attributes.

Parameters

string $name

Name of the attribute to set.

string $value

Value of the attribute to set.

Overrides

Helper::__set()

convertsource public

convert( string $serverTime , string|DateTimeZone $timezone )

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

Parameters

string $serverTime

UNIX timestamp

string|DateTimeZone $timezone

User's timezone string or DateTimeZone object

Returns

integer
UNIX timestamp

See

CakeTime::convert()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting

convertSpecifierssource 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 the modifier S for date()

string $time optional null

UNIX timestamp

Returns

string
Windows safe and date() function compatible format for strftime

See

CakeTime::convertSpecifiers()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting

dayAsSqlsource public

dayAsSql( integer|string|DateTime $dateString , string $fieldName , string|DateTimeZone $timezone null )

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

Parameters

integer|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string $fieldName

Name of database field to compare with

string|DateTimeZone $timezone optional null

User's timezone string or DateTimeZone object

Returns

string
Partial SQL string.

See

CakeTime::dayAsSql()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting

daysAsSqlsource public

daysAsSql( integer|string|DateTime $begin , integer|string|DateTime $end , string $fieldName , string|DateTimeZone $timezone null )

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

Parameters

integer|string|DateTime $begin

UNIX timestamp, strtotime() valid string or DateTime object

integer|string|DateTime $end

UNIX timestamp, strtotime() valid string or DateTime object

string $fieldName

Name of database field to compare with

string|DateTimeZone $timezone optional null

User's timezone string or DateTimeZone object

Returns

string
Partial SQL string.

See

CakeTime::daysAsSql()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting

formatsource public

format( integer|string|DateTime $format , integer|string|DateTime $date null , boolean $invalid false , string|DateTimeZone $timezone 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()

Examples

Create localized & formatted time:

$this->Time->format('2012-02-15', '%m-%d-%Y'); // returns 02-15-2012
$this->Time->format('2012-02-15 23:01:01', '%c'); // returns preferred date and time based on configured locale
$this->Time->format('0000-00-00', '%d-%m-%Y', 'N/A'); // return N/A because an invalid date was passed
$this->Time->format('2012-02-15 23:01:01', '%c', 'N/A', 'America/New_York'); // converts passed date to timezone

Parameters

integer|string|DateTime $format

date format string (or a UNIX timestamp, strtotime() valid string or DateTime object)

integer|string|DateTime $date optional null

UNIX timestamp, strtotime() valid string or DateTime object (or a date format string)

boolean $invalid optional false

flag to ignore results of fromString == false

string|DateTimeZone $timezone optional null

User's timezone string or DateTimeZone object

Returns

string
Formatted date string

See

CakeTime::format()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting

fromStringsource public

fromString( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )

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

Parameters

integer|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone $timezone optional null

User's timezone string or DateTimeZone object

Returns

string
Parsed timestamp

See

CakeTime::fromString()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting

gmtsource public

gmt( integer|string|DateTime $string null )

Returns gmt as a UNIX timestamp.

Parameters

integer|string|DateTime $string optional null

UNIX timestamp, strtotime() valid string or DateTime object

Returns

integer
UNIX timestamp

See

CakeTime::gmt()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting

i18nFormatsource public

i18nFormat( integer|string|DateTime $date , string $format null , boolean $invalid false , string|DateTimeZone $timezone null )

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

Parameters

integer|string|DateTime $date

UNIX timestamp, strtotime() valid string or DateTime object

string $format optional null

strftime format string.

boolean $invalid optional false

flag to ignore results of fromString == false

string|DateTimeZone $timezone optional null

User's timezone string or DateTimeZone object

Returns

string
Formatted and translated date string

See

CakeTime::i18nFormat()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting

isThisMonthsource public

isThisMonth( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )

Returns true if given datetime string is within this month

Parameters

integer|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone $timezone optional null

User's timezone string or DateTimeZone object

Returns

boolean
True if datetime string is within current month

See

CakeTime::isThisMonth()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#testing-time

isThisWeeksource public

isThisWeek( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )

Returns true if given datetime string is within this week.

Parameters

integer|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone $timezone optional null

User's timezone string or DateTimeZone object

Returns

boolean
True if datetime string is within current week

See

CakeTime::isThisWeek()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#testing-time

isThisYearsource public

isThisYear( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )

Returns true if given datetime string is within current year.

Parameters

integer|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone $timezone optional null

User's timezone string or DateTimeZone object

Returns

boolean
True if datetime string is within current year

See

CakeTime::isThisYear()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#testing-time

isTodaysource public

isToday( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )

Returns true if given datetime string is today.

Parameters

integer|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone $timezone optional null

User's timezone string or DateTimeZone object

Returns

boolean
True if datetime string is today

See

CakeTime::isToday()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#testing-time

isTomorrowsource public

isTomorrow( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )

Returns true if given datetime string is tomorrow.

Parameters

integer|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone $timezone optional null

User's timezone string or DateTimeZone object

Returns

boolean
True if datetime string was yesterday

See

CakeTime::isTomorrow()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#testing-time

isWithinNextsource public

isWithinNext( string|integer $timeInterval , integer|string|DateTime $dateString , string|DateTimeZone $timezone null )

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

Parameters

string|integer $timeInterval

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

integer|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone $timezone optional null

User's timezone string or DateTimeZone object

Returns

boolean
bool

See

CakeTime::isWithinLast()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#testing-time

nicesource public

nice( integer|string|DateTime $dateString null , string|DateTimeZone $timezone null , string $format null )

Returns a nicely formatted date string for given Datetime string.

Parameters

integer|string|DateTime $dateString optional null

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone $timezone optional null

User's timezone string or DateTimeZone object

string $format optional null

The format to use. If null, CakeTime::$niceFormat is used

Returns

string
Formatted date string

See

CakeTime::nice()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting

niceShortsource public

niceShort( integer|string|DateTime $dateString null , string|DateTimeZone $timezone null )

Returns a formatted descriptive date string for given datetime string.

Parameters

integer|string|DateTime $dateString optional null

UNIX timestamp, strtotime() valid string or DateTime object.

string|DateTimeZone $timezone optional null

User's timezone string or DateTimeZone object

Returns

string
Described, relative date string

See

CakeTime::niceShort()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting

serverOffsetsource public

serverOffset( )

Returns server's offset

Returns

integer
Offset

See

CakeTime::serverOffset()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting

timeAgoInWordssource public

timeAgoInWords( integer|string|DateTime $dateTime , array $options array() )

Formats a date into a phrase expressing the relative time.

Addition options

• element - The element to wrap the formatted time in. Has a few additional options: - tag - The tag to use, defaults to 'span'. - class - The class name to use, defaults to time-ago-in-words. - title - Defaults to the $dateTime input.

Parameters

integer|string|DateTime $dateTime

UNIX timestamp, strtotime() valid string or DateTime object

array $options optional array()

Default format if timestamp is used in $dateString

Returns

string
Relative time string.

See

CakeTime::timeAgoInWords()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting

toAtomsource public

toAtom( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )

Returns a date formatted for Atom RSS feeds.

Parameters

integer|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone $timezone optional null

User's timezone string or DateTimeZone object

Returns

string
Formatted date string

See

CakeTime::toAtom()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting

toQuartersource public

toQuarter( integer|string|DateTime $dateString , boolean $range false )

Returns the quarter

Parameters

integer|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

boolean $range optional false

if true returns a range in Y-m-d format

Returns

integer|array
1, 2, 3, or 4 quarter of year or array if $range true

See

CakeTime::toQuarter()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting

toRSSsource public

toRSS( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )

Formats date for RSS feeds

Parameters

integer|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone $timezone optional null

User's timezone string or DateTimeZone object

Returns

string
Formatted date string

See

CakeTime::toRSS()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting

toUnixsource public

toUnix( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )

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

Parameters

integer|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone $timezone optional null

User's timezone string or DateTimeZone object

Returns

integer
Unix timestamp

See

CakeTime::toUnix()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formatting

wasWithinLastsource public

wasWithinLast( string|integer $timeInterval , integer|string|DateTime $dateString , string|DateTimeZone $timezone null )

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

Parameters

string|integer $timeInterval

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

integer|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone $timezone optional null

User's timezone string or DateTimeZone object

Returns

boolean
bool

See

CakeTime::wasWithinLast()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#testing-time

wasYesterdaysource public

wasYesterday( integer|string|DateTime $dateString , string|DateTimeZone $timezone null )

Returns true if given datetime string was yesterday.

Parameters

integer|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone $timezone optional null

User's timezone string or DateTimeZone object

Returns

boolean
True if datetime string was yesterday

See

CakeTime::wasYesterday()

Link

http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#testing-time

_cleansource protected

_clean( )

Removes harmful content from output

_confirmsource protected

_confirm( string $message , string $okCode , string $cancelCode '' , array $options array() )

Returns a string to be used as onclick handler for confirm dialogs.

Parameters

string $message

Message to be displayed

string $okCode

Code to be executed after user chose 'OK'

string $cancelCode optional ''

Code to be executed after user chose 'Cancel'

array $options optional array()

Array of options

Returns

string
onclick JS code

_encodeUrlsource protected

_encodeUrl( string $url )

Encodes a URL for use in HTML attributes.

Parameters

string $url

The URL to encode.

Returns

string
The URL encoded for both URL & HTML contexts.

_formatAttributesource protected

_formatAttribute( string $key , string $value , boolean $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'

Deprecated

3.0.0 This method will be moved to HtmlHelper in 3.0

Parameters

string $key

The name of the attribute to create

string $value

The value of the attribute to create.

boolean $escape optional true

Define if the value must be escaped

Returns

string
The composed attribute.

_initInputFieldsource protected

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

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.

_namesource protected

_name( array|string $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

array|string $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

Field name.

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.

_parseAttributessource protected

_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 those listed in Helper::$_minimizedAttributes

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.

Deprecated

3.0.0 This method will be moved to HtmlHelper in 3.0

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.

_resetsource protected

_reset( )

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

_selectedArraysource protected

_selectedArray( string|array $data , string $key 'id' )

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

Parameters

string|array $data

Data array or model name.

string $key optional 'id'

Field name.

Returns

array
array

addClasssource 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 class name being added.

string $key optional 'class'

the key to use for class.

Returns

array
Array of options with $key set.

afterLayoutsource public

afterLayout( string $layoutFile )

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

Overridden in subclasses.

Parameters

string $layoutFile

The layout file that was rendered.

afterRendersource public

afterRender( string $viewFile )

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

Overridden in subclasses.

Parameters

string $viewFile

The view file that was rendered.

afterRenderFilesource public

afterRenderFile( string $viewFile , string $content )

After render file callback. Called after any view fragment is rendered.

Overridden in subclasses.

Parameters

string $viewFile

The file just be rendered.

string $content

The content that was rendered.

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

assetUrlsource public

assetUrl( string|array $path , array $options array() )

Generate URL for given asset file. Depending on options passed provides full URL with domain name. Also calls Helper::assetTimestamp() to add timestamp to local files

Parameters

string|array $path

Path string or URL array

array $options optional array()

Options array. Possible keys: fullBase Return full URL with domain name pathPrefix Path prefix for relative URLs ext Asset extension to append plugin False value will prevent parsing path as a plugin

Returns

string
Generated URL

beforeLayoutsource public

beforeLayout( string $layoutFile )

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

Overridden in subclasses.

Parameters

string $layoutFile

The layout about to be rendered.

beforeRendersource public

beforeRender( string $viewFile )

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

Overridden in subclasses.

Parameters

string $viewFile

The view file that is going to be rendered

beforeRenderFilesource public

beforeRenderFile( string $viewFile )

Before render file callback. Called before any view fragment is rendered.

Overridden in subclasses.

Parameters

string $viewFile

The file about to be rendered.

cleansource public

clean( string|array $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 possibilities. Escaping content is the best way to prevent all possible attacks.

Deprecated

3.0.0 This method will be removed in 3.0

Parameters

string|array $output

Either an array of strings to clean or a single string to clean.

Returns

string|array|null
Cleaned content for output

domIdsource public

domId( array|string $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

array|string $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.

entitysource public

entity( )

Returns the entity reference of the current context as an array of identity parts

Returns

array
An array containing the identity elements of an entity

fieldsource public

field( )

Gets the currently-used model field of the rendering context. Strips off field suffixes such as year, month, day, hour, min, meridian when the current entity is longer than 2 elements.

Returns

string
string

modelsource public

model( )

Gets the currently-used model of the rendering context.

Returns

string
string

outputsource public

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

3.0.0 This method will be removed in future versions.

Parameters

string $str

String to be output.

Returns

string
string

setEntitysource public

setEntity( string $entity , boolean $setScope false )

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

Parameters

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

urlsource public

url( string|array $url null , boolean $full false )

Finds URL for specified action.

Returns a URL pointing at the provided parameters.

Parameters

string|array $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/2.0/en/views/helpers.html

valuesource public

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

Gets the data for the current tag

Parameters

array|string $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

Field name.

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.

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

_mergeVarssource protected

_mergeVars( array $properties , string $class , boolean $normalize true )

Merges this objects $property with the property in $class' definition. This classes value for the property will be merged on top of $class'

This provides some of the DRY magic CakePHP provides. If you want to shut it off, redefine this method as an empty function.

Parameters

array $properties

The name of the properties to merge.

string $class

The class to merge the property with.

boolean $normalize optional true

Set to true to run the properties through Hash::normalize() before merging.

_setsource protected

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

_stopsource protected

_stop( integer|string $status 0 )

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

Parameters

integer|string $status optional 0

see http://php.net/exit for values

dispatchMethodsource 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

logsource public

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

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

Error type constant. Defined in app/Config/core.php.

null|string|array $scope optional null

The scope(s) a log message is being created in. See CakeLog::config() for more information on logging scopes.

Returns

boolean
Success of log write

requestActionsource public

requestAction( string|array $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.

Under the hood this method uses Router::reverse() to convert the $url parameter into a string URL. You should use URL formats that are compatible with Router::reverse()

Passing POST and GET data

POST and GET data can be simulated in requestAction. Use $extra['url'] for GET data. The $extra['data'] parameter allows POST data simulation.

Parameters

string|array $url

String or array-based URL. Unlike other URL arrays in CakePHP, this URL will not automatically handle passed and named arguments in the $url parameter.

array $extra optional array()

if array includes the key "return" it sets the AutoRender to true. Can also be used to submit GET/POST data, and named/passed arguments.

Returns

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

toStringsource public

toString( )

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

Returns

string
The name of this class

null

'%s="%s"'

null

array(
    'year', 'month', 'day', 'hour', 'min', 'second', 'meridian'
)

array()

'%s="%s"'

array(
    'allowfullscreen',
    'async',
    'autofocus',
    'autoplay',
    'checked',
    'compact',
    'controls',
    'declare',
    'default',
    'defaultchecked',
    'defaultmuted',
    'defaultselected',
    'defer',
    'disabled',
    'enabled',
    'formnovalidate',
    'hidden',
    'indeterminate',
    'inert',
    'ismap',
    'itemscope',
    'loop',
    'multiple',
    'muted',
    'nohref',
    'noresize',
    'noshade',
    'novalidate',
    'nowrap',
    'open',
    'pauseonexit',
    'readonly',
    'required',
    'reversed',
    'scoped',
    'seamless',
    'selected',
    'sortable',
    'spellcheck',
    'truespeed',
    'typemustmatch',
    'visible'
)

null

array()

array()

null

null

array()

array()

null