Class ModuleField

Module Field

Stores information regarding a particular Module Field, which may consist of a label, tooltip, input field, or some combination thereof.

Package: blesta\components\modules
Copyright: Copyright (c) 2010, Phillips Data, Inc.
License: The Blesta License Agreement
See: ModuleFields
Link: Blesta
Located at components/modules/module_field.php

Methods summary

`public`	# `__construct( string $type )` Constructs a new ModuleField of the given type. Types directly correlate to Form helper method names. Constructs a new ModuleField of the given type. Types directly correlate to Form helper method names. Parameters `$type` `string` $type The type of ModuleField
`public ModuleField`	# `setParam( string $name, mixed $value )` Sets all parameters for this ModuleField, which will be dispatched to the appropriate Form helper method when needed, or to the tooltip. Sets all parameters for this ModuleField, which will be dispatched to the appropriate Form helper method when needed, or to the tooltip. Parameters `$name` `string` $name The name of the parameter. For tooltip types this should be 'message' `$value` `mixed` $value The value of the parameter Returns `ModuleField`
`public ModuleField`	# `setLabel( ModuleField $label )` Sets the label associated with this specific field. Sets the label associated with this specific field. Parameters `$label` `ModuleField` $label The ModuleField label to associated with this field Returns `ModuleField`
`public ModuleField`	# `attach( ModuleField $field )` Attaches a field to a label ModuleField, or a tooltip to a label ModuleField. Only field and tooltip types can be attached to a label. So the current object must be of type "label". And $field must be of some other type. Attaches a field to a label ModuleField, or a tooltip to a label ModuleField. Only field and tooltip types can be attached to a label. So the current object must be of type "label". And $field must be of some other type. Parameters `$field` `ModuleField` $field The ModuleField to attach to this label Returns `ModuleField`

Magic methods summary

Properties summary

`public string`	`$type`	# The type of ModuleField The type of ModuleField
`public array`	`$params`	# All parameters set for this ModuleField All parameters set for this ModuleField
`public array`	`$fields`	# All fields or tooltips attached to this label All fields or tooltips attached to this label

Packages

Classes

Class ModuleField

Methods summary

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Magic methods summary

Properties summary