Class Helper

Properties summary

• $_View protected
  View
  The View instance this helper is attached to
• $_association protected
  string
  The name of the current model association entities are in scope of.
• $_attributeFormat protected
  string
  Format to attribute
• $_cleaned protected
  mixed
  Holds the cleaned content.
• $_entityPath protected
  string
  The dot separated list of elements the current field entity is for.
• $_fieldSuffixes protected
  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 protected
  array
  A helper lookup table used to lazy load helper objects.
• $_minimizedAttributeFormat protected
  string
  Format to attribute
• $_minimizedAttributes protected
  array
  Minimized attributes
• $_modelScope protected
  string
  The name of the current model entities are in scope of.
• $_tainted protected
  mixed
  Holds the content to be cleaned.
• $fieldset public
  array

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

• $helpers public
  array
  List of helpers used by this helper
• $plugin public
  string
  Plugin path
• $request public
  CakeRequest
  Request object
• $settings public
  array
  Settings for this helper.
• $tags public
  array
  Holds tag templates.
• $theme public
  string
  The current theme name if any.

Method Summary

• __call() public

  Provide non fatal errors on missing method calls.

• __construct() public

  Default Constructor

• __get() public deprecated

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

• __set() public deprecated

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

• _clean() protected

  Removes harmful content from output

• _confirm() protected

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

• _encodeUrl() protected

  Encodes a URL for use in HTML attributes.

• _formatAttribute() protected deprecated

  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'

• _initInputField() protected

  Sets the defaults for an input tag. Will set the name, value, and id attributes for an array of html attributes.

• _name() protected

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

• _parseAttributes() protected deprecated

  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

• _reset() protected

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

• _selectedArray() protected

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

• addClass() public

  Adds the given class to the element options

• afterLayout() public

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

• afterRender() public

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

• afterRenderFile() public

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

• assetTimestamp() public

  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.

• assetUrl() public

  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

• beforeLayout() public

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

• beforeRender() public

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

• beforeRenderFile() public

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

• clean() public deprecated

  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.

• domId() public

  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.

• entity() public

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

• field() public

  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.

• model() public

  Gets the currently-used model of the rendering context.

• output() public deprecated

  Returns a string generated by a helper method

• setEntity() public

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

• url() public

  Finds URL for specified action.

• value() public

  Gets the data for the current tag

• webroot() public

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

Method Detail

Methods inherited from Object

Properties detail

'%s="%s"'

null

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

array()

'%s="%s"'

array(
    'compact', 'checked', 'declare', 'readonly', 'disabled', 'selected',
    'defer', 'ismap', 'nohref', 'noshade', 'nowrap', 'multiple', 'noresize',
    'autoplay', 'controls', 'loop', 'muted', 'required', 'novalidate', 'formnovalidate'
)

null

array()

array()

null

null

array()

array()

null