CakePHP: API Generator

Adds the given class to the element options

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

Overridden in subclasses.

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

Overridden in subclasses.

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.

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

Overridden in subclasses.

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

Overridden in subclasses.

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.

Magic method handler.

Removes harmful content from 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.

Class constructor, overridden in descendant classes.

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

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.

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

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'

Default overload methods

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.

Parses tag templates into $this->tags.

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

Gets the currently-used model of the rendering context.

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

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

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()

Open the persistent class file for reading Used by Object::_persist()

Returns a string generated by a helper method

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

Overload implementation. No need for implementation in PHP5.

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
• true
• 'true'

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.

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

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.

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

You should choose a unique name for the persistent file

There are many uses for this method, see manual for examples

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

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.

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

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

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

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

Finds URL for specified action.

Returns a URL pointing at the provided parameters.

Gets the data for the current tag

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