Helper Class Info:
- Class Declaration:
class Helper extends Overloadable
- File name:
- cake/libs/view/helper.php
- Description:
Abstract base class for all other Helpers in CakePHP. Provides common methods and features.
- Class Inheritance
- Package
- cake
- Subpackage
- cake.cake.libs.view
Properties:
-
action string
Current action.
-
argSeparator string
URL argument separator character
-
base string
Base URL
-
data array
POST data for models
-
helpers array
List of helpers used by this helper
-
here string
URL to current action.
-
namedArgs array
List of named arguments
-
params array
Parameter array.
-
plugin string
Plugin path
-
tags array
Holds tag templates.
-
theme string
The current theme name if any.
-
validationErrors array
Contains model validation errors of form post-backs
-
webroot string
Webroot path
Method Summary:
- addClass( $options = array ( ), $class = NULL, $key = 'class' )
- afterLayout( )
- afterRender( )
- assetTimestamp( $path )
- beforeLayout( )
- beforeRender( )
- cakeError( $method, $messages = array ( ) )
- call__( $method, $params )
- clean( $output )
- __construct( )
- dispatchMethod( $method, $params = array ( ) )
- domId( $options = NULL, $id = 'id' )
- field( )
- get__( $name )
- _initInputField( $field, $options = array ( ) )
- loadConfig( $name = 'tags' )
- log( $msg, $type = 2 )
- model( )
- modelID( )
- _name( $options = array ( ), $field = NULL, $key = 'name' )
- Object( )
- output( $str )
- overload( )
- _parseAttributes( $options, $exclude = NULL, $insertBefore = ' ', $insertAfter = NULL )
- _persist( $name, $return, $object, $type = NULL )
- requestAction( $url, $extra = array ( ) )
- _savePersistent( $name, $object )
- set__( $name, $value )
- _set( $properties = array ( ) )
- setEntity( $entity, $setScope = false )
- _stop( $status = 0 )
- tagIsInvalid( $model = NULL, $field = NULL, $modelID = NULL )
- toString( )
- url( $url = NULL, $full = false )
- value( $options = array ( ), $field = NULL, $key = 'value' )
- webroot( $file )
addClass
topAdds 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/libs/view/helper.php on line 774
- Return
array Array of options with $key set.
- Access
public
afterLayout
topAfter layout callback. afterLayout is called after the layout has rendered.
Overridden in subclasses.
- Method defined in:
- cake/libs/view/helper.php on line 838
- Return
void
- Access
public
afterRender
topAfter render callback. afterRender is called after the view file is rendered but before the layout has been rendered.
Overridden in subclasses.
- Method defined in:
- cake/libs/view/helper.php on line 816
- Return
void
- Access
public
assetTimestamp
topAdds 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/libs/view/helper.php on line 242
- Return
string Path with a timestamp added, or not.
- Access
public
beforeLayout
topBefore layout callback. beforeLayout is called before the layout is rendered.
Overridden in subclasses.
- Method defined in:
- cake/libs/view/helper.php on line 827
- Return
void
- Access
public
beforeRender
topBefore render callback. beforeRender is called before the view file is rendered.
Overridden in subclasses.
- Method defined in:
- cake/libs/view/helper.php on line 804
- Return
void
- Access
public
cakeError
topUsed 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 required
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
-
- Method defined in:
- cake/libs/object.php on line 187
- Return
error message
- Access
public
call__
top- Parameters:
-
-
$method required
-
$params required
-
- Method defined in:
- cake/libs/view/helper.php on line 153
clean
topUsed 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.
- Parameters:
-
-
mixed $output required
Either an array of strings to clean or a single string to clean.
-
- Method defined in:
- cake/libs/view/helper.php on line 278
- Return
cleaned content for output
- Access
public
__construct
topClass constructor, overridden in descendant classes.
- Method defined in:
- cake/libs/object.php on line 54
dispatchMethod
topCalls 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/libs/object.php on line 107
- Return
mixed Returns the result of the method call
- Access
public
domId
topGenerates 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/libs/view/helper.php on line 604
- 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.
field
topGets the currently-used model field of the rendering context.
- Method defined in:
- cake/libs/view/helper.php on line 570
- Return
string
- Access
public
get__
topDefault overload methods
- Parameters:
-
-
$name required
-
- Method defined in:
- cake/libs/view/helper.php on line 151
- Access
protected
_initInputField
topSets 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/libs/view/helper.php on line 751
- Return
array Array options for the form input.
- Access
protected
loadConfig
topParses tag templates into $this->tags.
- Parameters:
-
-
$name optional 'tags'
-
- Method defined in:
- cake/libs/view/helper.php on line 164
- Return
array merged tags from config/$name.php
- Access
public
log
topConvience 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/libs/object.php on line 148
- Return
boolean Success of log write
- Access
public
model
topGets the currently-used model of the rendering context.
- Method defined in:
- cake/libs/view/helper.php on line 544
- Return
string
- Access
public
modelID
topGets the ID of the currently-used model of the rendering context.
- Method defined in:
- cake/libs/view/helper.php on line 559
- Return
mixed
- Access
public
_name
topGets 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/libs/view/helper.php on line 640
- 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.
- Access
protected
- Todo
Refactor this method to not have as many input/output options.
Object
topA 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()
- Method defined in:
- cake/libs/object.php on line 43
- Return
Object
output
topReturns 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/libs/view/helper.php on line 792
- Return
string
- Deprecated
This method will be removed in future versions.
overload
topOverload implementation. No need for implementation in PHP5.
- Method defined in:
- cake/libs/overloadable_php5.php on line 36
- Access
public
_parseAttributes
topReturns 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/libs/view/helper.php on line 334
- Return
string Composed attributes.
- Access
public
_persist
topChecks 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 required
name of the class to persist
-
$return required
-
string $object required
the object to persist
-
$type optional NULL
-
- Method defined in:
- cake/libs/object.php on line 218
- Return
boolean Success
- Access
protected
- Todo
add examples to manual
requestAction
topCalls 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.
- Parameters:
-
-
mixed $url required
String or array-based url.
-
array $extra optional array ( )
if array includes the key "return" it sets the AutoRender to true.
-
- Method defined in:
- cake/libs/object.php on line 80
- Return
mixed Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
- Access
public
_savePersistent
topYou should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
- Parameters:
-
-
string $name required
name used for object to cache
-
object $object required
the object to persist
-
- Method defined in:
- cake/libs/object.php on line 247
- Return
boolean true on save, throws error if file can not be created
- Access
protected
set__
top_set
topAllows 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/libs/object.php on line 166
- Return
void
- Access
protected
setEntity
topSets 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/libs/view/helper.php on line 394
- Return
void
- Access
public
_stop
topStop execution of the current script. Wraps exit() making testing easier.
- Parameters:
-
-
$status optional 0
-
- Method defined in:
- cake/libs/object.php on line 135
- Return
void
- Access
public
tagIsInvalid
topReturns 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 a string
-
string $field optional NULL
Fieldname as a string
-
integer $modelID optional NULL
Unique index identifying this record within the form
-
- Method defined in:
- cake/libs/view/helper.php on line 584
- Return
boolean True on errors.
toString
topObject-to-string conversion. Each class can override this method as necessary.
- Method defined in:
- cake/libs/object.php on line 64
- Return
string The name of this class
- Access
public
url
topFinds 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/23or 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/libs/view/helper.php on line 187
- Return
string Full translated URL with base path.
- Access
public
- Link
- http://book.cakephp.org/view/1448/url
value
topGets 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/libs/view/helper.php on line 686
- 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.
- Access
public
- Todo
Refactor this method to not have as many input/output options.
webroot
topChecks 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/libs/view/helper.php on line 198
- Return
string Web accessible path to file.
- Access
public
