Class Helper

Backend for helpers.

Long description for class

Object

Overloadable

Helper

Package: cake\cake\libs\view
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: The MIT License
Location: view/helper.php

Properties summary

$__cleaned public

mixed

Holds the cleaned content.
$__tainted public

mixed

Holds the content to be cleaned.
$action public

string

Current action.
$argSeparator public

string

URL argument separator character
$base public

string

Base URL
$data public

array

POST data for models
$helpers public

array

List of helpers used by this helper
$here public

string

URL to current action.
$namedArgs public

array

List of named arguments
$params public

array

Parameter array.
$plugin public

string

Plugin path
$tags public

array

Holds tag templates.
$themeWeb public

string

Theme name
$validationErrors public

array

Contains model validation errors of form post-backs
$webroot public

string

Webroot path

Inherited Properties

_log

Method Summary

__clean() public

Removes harmful content from output
__formatAttribute() public
__name() public

Gets the input field name for the current tag
__reset() public

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

Transforms a recordset from a hasAndBelongsToMany association to a list of selected options for a multiple select element
_initInputField() public

Sets the defaults for an input tag
_parseAttributes() public

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'
addClass() public

Adds the given class to the element options
afterLayout() public

After layout callback. Overridden in subclasses.
afterRender() public

After render callback. Overridden in subclasses.
beforeLayout() public

Before layout callback. Overridden in subclasses.
beforeRender() public

Before render callback. Overridden in subclasses.
call__() public
clean() public

Used to remove harmful tags from content
domId() public

Generates a DOM ID for the selected element, if one is not set.
field() public

Gets the currently-used model field of the rendering context.
get__() public

Default overload methods
loadConfig() public

Parses tag templates into $this->tags.
model() public

Gets the currently-used model of the rendering context.
modelID() public

Gets the ID of the currently-used model of the rendering context.
output() public

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.
set__() public
tagIsInvalid() public

Returns false if given FORM field has no errors. Otherwise it returns the constant set in the array Model->validationErrors.
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

__clean() public ¶

__clean( )

Removes harmful content from output

__formatAttribute() public ¶

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

Parameters

string $key
string $value
$escape optional true

Returns

string

__name() public ¶

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

Gets the input field name for the current tag

Parameters

array $options optional array()
string $field optional null: $key
$key optional 'name'

Returns

array

__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( array $field , string $options = array() )

Sets the defaults for an input tag

Parameters

array $field: $options
string $options optional array(): $key

Returns

array

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

Parameters

array $options: Array of options.
array $exclude optional null: Array of options to be excluded.
string $insertBefore optional ' ': String to be inserted before options.
string $insertAfter optional null: String to be inserted ater options.

Returns

string

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()
string $class optional null
string $key optional 'class'

Returns

array

afterLayout() public ¶

afterLayout( )

After layout callback. Overridden in subclasses.

afterRender() public ¶

afterRender( )

After render callback. Overridden in subclasses.

beforeLayout() public ¶

beforeLayout( )

Before layout callback. Overridden in subclasses.

beforeRender() public ¶

beforeRender( )

Before render callback. Overridden in subclasses.

call__() public ¶

call__( $method , $params )

clean() public ¶

clean( mixed $output )

Used to remove harmful tags from content

Parameters

mixed $output

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.

Parameters

mixed $options optional null
string $id optional 'id'

Returns

mixed

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

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 ¶

output( string $str )

Returns a string generated by a helper method

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

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 false 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 string
string $field optional null: Fieldname as string
integer $modelID optional null: Unique index identifying this record within the form

Returns

boolean
True on errors.

url() public ¶

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

Finds URL for specified action.

Returns an URL pointing to a combination of controller and action. Param $url can be: + Empty - the method will find adress to actuall controller/action. + '/' - the method will find base URL of application. + A combination of controller/action - the method will find url for it.

Parameters

mixed $url optional null: Cake-relative URL, like "/products/edit/92" or "/presidents/elect/4" or an array specifying any of the following: 'controller', 'action', and/or 'plugin', in addition to named arguments (keyed array elements), and standard URL arguments (indexed array elements)
boolean $full optional false: If true, the full base URL will be prepended to the result

Returns

string
Full translated URL with base path.

value() public ¶

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

Gets the data for the current tag

Parameters

array $options optional array()
string $field optional null: $key
$key optional 'value'

Returns

array

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

Returns

string
$webPath web 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.

Parameters

array $properties optional array(): An associative array containing properties and corresponding values.

_stop() public ¶

_stop( $status = 0 )

Stop execution of the current script

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, and improves performance by using straight method calls in most cases.

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 )

API for logging events.

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.

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

Properties detail

`$__cleaned` ¶

public mixed

Holds the cleaned content.

null

`$__tainted` ¶

public mixed

Holds the content to be cleaned.

null

`$action` ¶

public string

Current action.

null

`$argSeparator` ¶

public string

URL argument separator character

null

`$base` ¶

public string

Base URL

null

`$data` ¶

public array

POST data for models

null

`$helpers` ¶

public array

List of helpers used by this helper

null

`$here` ¶

public string

URL to current action.

null

`$namedArgs` ¶

public array

List of named arguments

null

`$params` ¶

public array

Parameter array.

array()

`$plugin` ¶

public string

Plugin path

null

`$tags` ¶

public array

Holds tag templates.

array()

`$themeWeb` ¶

public string

Theme name

null

`$validationErrors` ¶

public array

Contains model validation errors of form post-backs

null

`$webroot` ¶

public string

Webroot path

null

Classes

Functions

Class Helper

Properties summary

Inherited Properties

Method Summary

__clean() public

__formatAttribute() public

__name() public

__reset() public

__selectedArray() public

_initInputField() public

_parseAttributes() public

addClass() public

afterLayout() public

afterRender() public

beforeLayout() public

beforeRender() public

call__() public

clean() public

domId() public

field() public

get__() public

loadConfig() public

model() public

modelID() public

output() public

setEntity() public

set__() public

tagIsInvalid() public

url() public

value() public

webroot() public

Method Detail

__clean() public ¶

__formatAttribute() public ¶

Parameters

Returns

__name() public ¶

Parameters

Returns

__reset() public ¶

__selectedArray() public ¶

Parameters

Returns

_initInputField() public ¶

Parameters

Returns

_parseAttributes() public ¶

Parameters

Returns

addClass() public ¶

Parameters

Returns

afterLayout() public ¶

afterRender() public ¶

beforeLayout() public ¶

beforeRender() public ¶

call__() public ¶

clean() public ¶

Parameters

Returns

domId() public ¶

Parameters

Returns

field() public ¶

Returns

get__() public ¶

loadConfig() public ¶

Parameters

Returns

model() public ¶

Returns

modelID() public ¶

Returns

output() public ¶

Parameters

Returns

setEntity() public ¶

Parameters