Class ModuleFields

Module Fields

Provides the structure for modules to set which fields to appear when interacting with the module via adding/editing packages or services.

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

Methods summary

`public array`	# `getFields( )` Returns an array of fields set for this group of fields Returns an array of fields set for this group of fields Returns `array` An array of ModuleField objects set for this group of fields
`public string`	# `getHtml( )` Returns an HTML content set for this group of fields Returns an HTML content set for this group of fields Returns `string` The HTML content set for this group of fields
`public`	# `setHtml( string $html )` Sets HTML content to be rendered into the view when outputting the fields. This is intended to allow for the inclusion of javascript to dynamically handle the rendering of the fields, but is not limited to such. Sets HTML content to be rendered into the view when outputting the fields. This is intended to allow for the inclusion of javascript to dynamically handle the rendering of the fields, but is not limited to such. Parameters `$html` `string` $html The HTML content to render into the view when outputting the fields
`public`	# `setField( ModuleField $field )` Sets the field into the collection of ModuleField objects Sets the field into the collection of ModuleField objects Parameters `$field` `ModuleField` A ModuleField object to be passed set into the list of ModuleField objects
`public ModuleField`	# `label( string $name, string $for = null, array $attributes = null, boolean $preserve_tags = false )` Creates a label with the given name and marks it for the given field Creates a label with the given name and marks it for the given field Parameters `$name` `string` $name The name of this label `$for` `string` $for The ID of the form element this label is part of `$attributes` `array` $attributes Attributes for this label `$preserve_tags` `boolean` $preserve_tags True to preserve tags in the label name Returns `ModuleField` A ModuleField object to be passed into one of the various field methods to assign this label to that field
`public ModuleField`	# `tooltip( string $message )` Creates a tooltip with the given message Creates a tooltip with the given message Parameters `$message` `string` $message The tooltip message Returns `ModuleField` A ModuleField object that can be attached to a ModuleField label
`public ModuleField`	# `fieldText( string $name, string $value = null, array $attributes = array(), ModuleField $label = null )` Creates a text input field Creates a text input field Parameters `$name` `string` $name The name to set in the HTML name field `$value` `string` $value The value to set in the HTML value field `$attributes` `array` $attributes Attributes for this input field `$label` `ModuleField` A ModuleField object representing the label to attach to this field (see ModuleFields::label) Returns `ModuleField` A ModuleField object that can be attached to a ModuleField label See `ModuleFields::label()` `ModuleField::attach()`
`public ModuleField`	# `fieldHidden( string $name, string $value = null, array $attributes = array() )` Creates a hidden input field Creates a hidden input field Parameters `$name` `string` $name The name to set in the HTML name field `$value` `string` $value The value to set in the HTML value field `$attributes` `array` $attributes Attributes for this input field Returns `ModuleField` A ModuleField object that can be attached to a ModuleField label See `ModuleFields::label()` `ModuleField::attach()`
`public ModuleField`	# `fieldImage( string $name, string $value = null, array $attributes = array(), ModuleField $label = null )` Creates an image input field Creates an image input field Parameters `$name` `string` $name The name to set in the HTML name field `$value` `string` $value The value to set in the HTML value field `$attributes` `array` $attributes Attributes for this input field `$label` `ModuleField` A ModuleField object representing the label to attach to this field (see ModuleFields::label) Returns `ModuleField` A ModuleField object that can be attached to a ModuleField label See `ModuleFields::label()` `ModuleField::attach()`
`public ModuleField`	# `fieldReset( string $name, string $value = null, array $attributes = array(), ModuleField $label = null )` Creates a reset input field Creates a reset input field Parameters `$name` `string` $name The name to set in the HTML name field `$value` `string` $value The value to set in the HTML value field `$attributes` `array` $attributes Attributes for this input field `$label` `ModuleField` A ModuleField object representing the label to attach to this field (see ModuleFields::label) Returns `ModuleField` A ModuleField object that can be attached to a ModuleField label See `ModuleFields::label()` `ModuleField::attach()`
`public ModuleField`	# `fieldCheckbox( string $name, string $value = null, boolean $checked = false, array $attributes = array(), ModuleField $label = null )` Creates a checkbox Creates a checkbox Parameters `$name` `string` $name The name to set in the HTML name field `$value` `string` $value The value to set in the HTML value field `$checked` `boolean` $checked True to set this field as checked `$attributes` `array` $attributes Attributes for this input field `$label` `ModuleField` A ModuleField object representing the label to attach to this field (see ModuleFields::label) Returns `ModuleField` A ModuleField object that can be attached to a ModuleField label See `ModuleFields::label()` `ModuleField::attach()`
`public ModuleField`	# `fieldRadio( string $name, string $value = null, boolean $checked = false, array $attributes = array(), ModuleField $label = null )` Creates a radio box Creates a radio box Parameters `$name` `string` $name The name to set in the HTML name field `$value` `string` $value The value to set in the HTML value field `$checked` `boolean` $checked True to set this field as checked `$attributes` `array` $attributes Attributes for this input field `$label` `ModuleField` A ModuleField object representing the label to attach to this field (see ModuleFields::label) Returns `ModuleField` A ModuleField object that can be attached to a ModuleField label See `ModuleFields::label()` `ModuleField::attach()`
`public ModuleField`	# `fieldTextarea( string $name, string $value = null, array $attributes = array(), ModuleField $label = null )` Creates a textarea field Creates a textarea field Parameters `$name` `string` $name The name to set in the HTML name field `$value` `string` $value The value to set in this textarea `$attributes` `array` $attributes Attributes for this input field `$label` `ModuleField` A ModuleField object representing the label to attach to this field (see ModuleFields::label) Returns `ModuleField` A ModuleField object that can be attached to a ModuleField label See `ModuleFields::label()` `ModuleField::attach()`
`public ModuleField`	# `fieldPassword( string $name, array $attributes = array(), ModuleField $label = null )` Creates a password input field Creates a password input field Parameters `$name` `string` $name The name to set in the HTML name field `$attributes` `array` $attributes Attributes for this input field `$label` `ModuleField` A ModuleField object representing the label to attach to this field (see ModuleFields::label) Returns `ModuleField` A ModuleField object that can be attached to a ModuleField label See `ModuleFields::label()` `ModuleField::attach()`
`public ModuleField`	# `fieldFile( string $name, array $attributes = array(), ModuleField $label = null )` Creates a file input field Creates a file input field Parameters `$name` `string` $name The name to set in the HTML name field `$attributes` `array` $attributes Attributes for this input field `$label` `ModuleField` A ModuleField object representing the label to attach to this field (see ModuleFields::label) Returns `ModuleField` A ModuleField object that can be attached to a ModuleField label See `ModuleFields::label()` `ModuleField::attach()`
`public ModuleField`	# `fieldSelect( string $name, array $options = array(), mixed $selected_value = null, array $attributes = array(), array $option_attributes = array(), ModuleField $label = null )` Creates a select list Creates a select list Parameters `$name` `string` $name The name to set in the HTML name field `$options` `array` $options The options to place in this select list `$selected_value` `mixed` $selected_value The option(s) to set as selected `$attributes` `array` $attributes Attributes for this input field `$option_attributes` `array` $option_attributes Attributes for each option to set. If single dimension will set the attributes for every option, if multi-dimensional will set option for each element key that matches in $options `$label` `ModuleField` A ModuleField object representing the label to attach to this field (see ModuleFields::label) Returns `ModuleField` A ModuleField object that can be attached to a ModuleField label See `ModuleFields::label()` `ModuleField::attach()`
`public ModuleField`	# `fieldMultiSelect( string $name, array $options = array(), string $selected_values = array(), array $attributes = array(), array $option_attributes = array(), ModuleField $label = null )` Creates a select list with multiple selectable options Creates a select list with multiple selectable options Parameters `$name` `string` $name The name to set in the HTML name field `$options` `array` $options The options to place in this select list `$selected_values` `string` $selected_values The options to set as selected `$attributes` `array` $attributes Attributes for this input field `$option_attributes` `array` $option_attributes Attributes for each option to set. If single dimension will set the attributes for every option, if multi-dimensional will set option for each element key that matches in $options `$label` `ModuleField` A ModuleField object representing the label to attach to this field (see ModuleFields::label) Returns `ModuleField` A ModuleField object that can be attached to a ModuleField label See `ModuleFields::label()` `ModuleField::attach()`
`public ModuleField`	# `fieldButton( string $name, string $value = null, array $attributes = array(), ModuleField $label = null )` Creates a button with default type=button, can be overriden by attirbutes Creates a button with default type=button, can be overriden by attirbutes Parameters `$name` `string` $name The name to set in the HTML name field `$value` `string` $value The value to set in the HTML value field `$attributes` `array` $attributes Attributes for this input field `$label` `ModuleField` A ModuleField object representing the label to attach to this field (see ModuleFields::label) Returns `ModuleField` A ModuleField object that can be attached to a ModuleField label See `ModuleFields::label()` `ModuleField::attach()`
`public ModuleField`	# `fieldSubmit( string $name, string $value = null, array $attributes = array(), ModuleField $label = null )` Creates a button of type submit Creates a button of type submit Parameters `$name` `string` $name The name to set in the HTML name field `$value` `string` $value The value to set in the HTML value field `$attributes` `array` $attributes Attributes for this input field `$label` `ModuleField` A ModuleField object representing the label to attach to this field (see ModuleFields::label) Returns `ModuleField` A ModuleField object that can be attached to a ModuleField label See `ModuleFields::label()` `ModuleField::attach()`

Packages

Classes

Class ModuleFields

Methods summary

Returns

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

See

Magic methods summary