CacheHelper Class Info:

Class Declaration:

class CacheHelper extends AppHelper

File name:
Cake/View/Helper/CacheHelper.php
Description:

CacheHelper helps create full page view caching.

When using CacheHelper you don't call any of its methods, they are all automatically called by View, and use the $cacheAction settings set in the controller.

Class Inheritance

AppHelper Helper Object

Properties:

Show/Hide parent properties
  • _association string

    The name of the current model association entities are in scope of.

  • _attributeFormat string

    Format to attribute

  • _cleaned mixed

    Holds the cleaned content.

  • _counter integer

    Counter used for counting nocache section tags.

  • _entityPath string

    The dot separated list of elements the current field entity is for.

  • fieldset array

    Holds the fields array('field_name' => array('type' => 'string', 'length' => 100), primaryKey and validates array('field_name')

  • _fieldSuffixes array

    A list of strings that should be treated as suffixes, or sub inputs for a parent input. This is used for date/time inputs primarily.

  • _helperMap array

    A helper lookup table used to lazy load helper objects.

  • helpers array

    List of helpers used by this helper

  • _match array

    Array of string that are replace with there var replace above. The strings are any content inside <!--nocache--><!--/nocache--> and includes the tags in views

  • _minimizedAttributeFormat string

    Format to attribute

  • _minimizedAttributes array

    Minimized attributes

  • _modelScope string

    The name of the current model entities are in scope of.

  • plugin string

    Plugin path

  • _replace array

    Array of strings replaced in cached views. The strings are found between <!--nocache--><!--/nocache--> in views

  • request CakeRequest

    Request object

  • tags array

    Holds tag templates.

  • _tainted mixed

    Holds the content to be cleaned.

  • theme string

    The current theme name if any.

  • _View View

    The View instance this helper is attached to

addClass

top

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.

Method defined in:
Cake/View/Helper.php on line 746
Return

array Array of options with $key set.

afterLayout

top

Parses the layout file and stores content for cache file building.

Parameters:
  • string $layoutFile required

Method defined in:
Cake/View/Helper/CacheHelper.php on line 83
Return

void

afterRender

top

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 required

    The view file that was rendered.

Method defined in:
Cake/View/Helper.php on line 788
Return

void

afterRenderFile

top

Parses the view file and stores content for cache file building.

Parameters:
  • string $viewFile required

  • $output required

Method defined in:
Cake/View/Helper/CacheHelper.php on line 71
Return

void

assetTimestamp

top

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 required

    The file path to timestamp, the path must be inside WWW_ROOT

Method defined in:
Cake/View/Helper.php on line 331
Return

string Path with a timestamp added, or not.

assetUrl

top

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:
  • $path required

  • 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

Method defined in:
Cake/View/Helper.php on line 293
Return

string Generated url

beforeLayout

top

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

Overridden in subclasses.

Parameters:
  • string $layoutFile required

    The layout about to be rendered.

Method defined in:
Cake/View/Helper.php on line 799
Return

void

beforeRender

top

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

Overridden in subclasses.

Parameters:
  • string $viewFile required

    The view file that is going to be rendered

Method defined in:
Cake/View/Helper.php on line 776
Return

void

beforeRenderFile

top

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

Overridden in subclasses.

Parameters:
  • $viewfile required

Method defined in:
Cake/View/Helper.php on line 822
Return

void

cache

top

Main method used to cache a view

Parameters:
  • string $file required

    File to cache

  • string $out required

    output to cache

Method defined in:
Cake/View/Helper/CacheHelper.php on line 113

__call

top

Provide non fatal errors on missing method calls.

Parameters:
  • string $method required

    Method to invoke

  • array $params required

    Array of params for the method.

Method defined in:
Cake/View/Helper.php on line 178
Return

void

clean

top

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.

Parameters:
  • mixed $output required

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

Method defined in:
Cake/View/Helper.php on line 366
Return

string|array cleaned content for output

_clean

top

Removes harmful content from output

Method defined in:
Cake/View/Helper.php on line 882
Return

void

__construct

top

Default Constructor

Parameters:
  • View $View required

    The View this helper is being attached to.

  • array $settings optional array ( )

    Configuration settings for the helper.

Method defined in:
Cake/View/Helper.php on line 163

dispatchMethod

top

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

Parameters:
  • string $method required

    Name of the method to call

  • array $params optional array ( )

    Parameter list to use when calling $method

Method defined in:
Cake/Core/Object.php on line 110
Return

mixed Returns the result of the method call

domId

top

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.

Method defined in:
Cake/View/Helper.php on line 593
Return

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

Todo

Refactor this method to not have as many input/output options.

_enabled

top

Is CacheHelper enabled? should files + output be parsed.

Method defined in:
Cake/View/Helper/CacheHelper.php on line 61
Return

boolean

entity

top

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

Method defined in:
Cake/View/Helper.php on line 549
Return

array An array containing the identity elements of an entity

field

top

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.

Method defined in:
Cake/View/Helper.php on line 572
Return

string

_formatAttribute

top

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 required

    The name of the attribute to create

  • string $value required

    The value of the attribute to create.

  • boolean $escape optional true

    Define if the value must be escaped

Method defined in:
Cake/View/Helper.php on line 456
Return

string The composed attribute.

Deprecated

This method will be moved to HtmlHelper in 3.0

__get

top

Lazy loads helpers. Provides access to deprecated request properties as well.

Parameters:
  • string $name required

    Name of the property being accessed.

Method defined in:
Cake/View/Helper.php on line 188
Return

mixed Helper or property found at $name

_initInputField

top

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 required

    The field name to initialize.

  • array $options optional array ( )

    Array of options to use while initializing an input field.

Method defined in:
Cake/View/Helper.php on line 727
Return

array Array options for the form input.

log

top

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

Parameters:
  • string $msg required

    Log message

  • integer $type optional 2

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

Method defined in:
Cake/Core/Object.php on line 149
Return

boolean Success of log write

_mergeVars

top

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 required

    The name of the properties to merge.

  • string $class required

    The class to merge the property with.

  • boolean $normalize optional true

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

Method defined in:
Cake/Core/Object.php on line 187
Return

void

model

top

Gets the currently-used model of the rendering context.

Method defined in:
Cake/View/Helper.php on line 558
Return

string

_name

top

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

    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 $key optional 'name'

    The name of the attribute to be set, defaults to 'name'

Method defined in:
Cake/View/Helper.php on line 626
Return

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.

Todo

Refactor this method to not have as many input/output options.

output

top

Returns a string generated by a helper method

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

Parameters:
  • string $str required

    String to be output.

Method defined in:
Cake/View/Helper.php on line 764
Return

string

Deprecated

This method will be removed in future versions.

_parseAttributes

top

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 required

    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.

Method defined in:
Cake/View/Helper.php on line 422
Return

string Composed attributes.

Deprecated

This method will be moved to HtmlHelper in 3.0

_parseContent

top

Parse a file + output. Matches nocache tags between the current output and the current file stores a reference of the file, so the generated can be swapped back with the file contents when writing the cache file.

Parameters:
  • string $file required

    The filename to process.

  • string $out required

    The output for the file.

Method defined in:
Cake/View/Helper/CacheHelper.php on line 99
Return

string Updated content.

_parseFile

top

Parse file searching for no cache tags

Parameters:
  • string $file required

    The filename that needs to be parsed.

  • string $cache required

    The cached content

Method defined in:
Cake/View/Helper/CacheHelper.php on line 166
Return

void

_parseOutput

top

Parse the output and replace cache tags

Parameters:
  • string $cache required

    Output to replace content in.

Method defined in:
Cake/View/Helper/CacheHelper.php on line 228
Return

string with all replacements made to <!--nocache--><!--nocache-->

_replaceSection

top

Munges the output from a view with cache tags, and numbers the sections. This helps solve issues with empty/duplicate content.

Method defined in:
Cake/View/Helper/CacheHelper.php on line 205
Return

string The content with cake:nocache tags replaced.

requestAction

top

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:
  • mixed $url required

    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.

Method defined in:
Cake/Core/Object.php on line 66
Return

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

_reset

top

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

Method defined in:
Cake/View/Helper.php on line 872
Return

void

_selectedArray

top

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

Parameters:
  • mixed $data required

  • string $key optional 'id'

Method defined in:
Cake/View/Helper.php on line 846
Return

array

_set

top

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.

Method defined in:
Cake/Core/Object.php on line 164
Return

void

__set

top

Provides backwards compatibility access for setting values to the request object.

Parameters:
  • string $name required

    Name of the property being accessed.

  • mixed $value required

    Name of the property being accessed.

Method defined in:
Cake/View/Helper.php on line 216
Return

mixed Return the $value

setEntity

top

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

Parameters:
  • mixed $entity required

    A field name, like "ModelName.fieldName" or "ModelName.ID.fieldName"

  • boolean $setScope optional false

    Sets the view scope to the model specified in $tagValue

Method defined in:
Cake/View/Helper.php on line 481
Return

void

_stop

top

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

Parameters:
Method defined in:
Cake/Core/Object.php on line 137
Return

void

_stripTags

top

Strip cake:nocache tags from a string. Since View::render() only removes un-numbered nocache tags, remove all the numbered ones. This is the complement to _replaceSection.

Parameters:
  • string $content required

    String to remove tags from.

Method defined in:
Cake/View/Helper/CacheHelper.php on line 218
Return

string String with tags removed.

toString

top

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

Method defined in:
Cake/Core/Object.php on line 41
Return

string The name of this class

url

top

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

Method defined in:
Cake/View/Helper.php on line 241
Return

string Full translated URL with base path.

Link
http://book.cakephp.org/2.0/en/views/helpers.html

value

top

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

    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 $key optional 'value'

    The name of the attribute to be set, defaults to 'value'

Method defined in:
Cake/View/Helper.php on line 670
Return

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.

Todo

Refactor this method to not have as many input/output options.

webroot

top

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

Parameters:
  • string $file required

    The file to create a webroot path to.

Method defined in:
Cake/View/Helper.php on line 251
Return

string Web accessible path to file.

_writeFile

top

Write a cached version of the file

Parameters:
  • string $content required

    view content to write to a cache file.

  • string $timestamp required

    Duration to set for cache file.

  • boolean $useCallbacks optional false

    Duration to set for cache file.

Method defined in:
Cake/View/Helper/CacheHelper.php on line 262
Return

boolean success of caching view.