Class FOFFormHeader

An interface for FOFFormHeader fields, used to define the filters and the elements of the header row in repeatable (browse) views

Direct known subclasses

FOFFormHeaderField, FOFFormHeaderOrdering, FOFFormHeaderRowselect

Indirect known subclasses

FOFFormHeaderAccesslevel, FOFFormHeaderFielddate, FOFFormHeaderFiltersql, FOFFormHeaderLanguage, FOFFormHeaderModel, FOFFormHeaderPublished, FOFFormHeaderFieldfilterable, FOFFormHeaderFieldsearchable, FOFFormHeaderFieldselectable, FOFFormHeaderFieldsql, FOFFormHeaderFilterdate, FOFFormHeaderFilterfilterable, FOFFormHeaderFiltersearchable, FOFFormHeaderFilterselectable

Abstract
Package: FrameworkOnFramework\form
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 2.0
Located at fof/form/header.php

Methods summary

`public`	# `__construct( FOFForm $form = null )` Method to instantiate the form field object. Method to instantiate the form field object. Parameters `$form` `FOFForm` - $form The form to attach to the form field object. Since 2.0
`public mixed`	# `__get( string $name )` Method to get certain otherwise inaccessible properties from the form field object. Method to get certain otherwise inaccessible properties from the form field object. Parameters `$name` `string` - $name The property name for which to the the value. Returns `mixed` - The property value or null. Since 2.0
`public FOFFormHeader`	# `setForm( FOFForm $form )` Method to attach a JForm object to the field. Method to attach a JForm object to the field. Parameters `$form` `FOFForm` - $form The JForm object to attach to the form field. Returns `FOFFormHeader` - The form field object so that the method can be used in a chain. Since 2.0
`public boolean`	# `setup( SimpleXMLElement $element, mixed $value, string $group = null )` Method to attach a FOFForm object to the field. Method to attach a FOFForm object to the field. Parameters `$element` `SimpleXMLElement` - $element The SimpleXMLElement object representing the <field /> tag for the form field object. `$value` `mixed` - $value The form field value to validate. `$group` `string` - $group The field name group control value. This acts as an array container for the field. For example if the field has name="foo" and the group value is set to "bar" then the full field name would end up being "bar[foo]". Returns `boolean` - True on success. Since 2.0
`protected string`	# `getId( string $fieldId, string $fieldName )` Method to get the id used for the field input tag. Method to get the id used for the field input tag. Parameters `$fieldId` `string` - $fieldId The field element id. `$fieldName` `string` - $fieldName The field element name. Returns `string` - The id to be used for the field input tag. Since 2.0
`protected string`	# `getName( string $fieldName )` Method to get the name used for the field input tag. Method to get the name used for the field input tag. Parameters `$fieldName` `string` - $fieldName The field element name. Returns `string` - The name to be used for the field input tag. Since 2.0
`protected string`	# `getFieldName( string $fieldName )` Method to get the field name used. Method to get the field name used. Parameters `$fieldName` `string` - $fieldName The field element name. Returns `string` - The field name Since 2.0
`protected string`	# `getLabel( )` Method to get the field label. Method to get the field label. Returns `string` - The field label. Since 2.0
`protected mixed`	# `getValue( )` Get the filter value for this header field Get the filter value for this header field Returns `mixed` - The filter value
`protected string`	# `getFilterSource( string $filterSource )` Return the key of the filter value in the model state or, if it's not set, the name of the field. Return the key of the filter value in the model state or, if it's not set, the name of the field. Parameters `$filterSource` `string` - $filterSource The filter source value to return Returns `string`
`protected boolean`	# `getSortable( )` Is this a sortable field? Is this a sortable field? Returns `boolean` - True if it's sortable
`protected string\|null`	# `getHeader( )` Returns the HTML for the header row, or null if this element should render no header element Returns the HTML for the header row, or null if this element should render no header element Returns `string\|null` - HTML code or null if nothing is to be rendered Since 2.0
`protected string\|null`	# `getFilter( )` Returns the HTML for a text filter to be rendered in the filter row, or null if this element should render no text input filter. Returns the HTML for a text filter to be rendered in the filter row, or null if this element should render no text input filter. Returns `string\|null` - HTML code or null if nothing is to be rendered Since 2.0
`protected string\|null`	# `getButtons( )` Returns the HTML for the buttons to be rendered in the filter row, next to the text input filter, or null if this element should render no text input filter buttons. Returns the HTML for the buttons to be rendered in the filter row, next to the text input filter, or null if this element should render no text input filter buttons. Returns `string\|null` - HTML code or null if nothing is to be rendered Since 2.0
`protected array`	# `getOptions( )` Returns the JHtml options for a drop-down filter. Do not include an empty option, it is added automatically. Returns the JHtml options for a drop-down filter. Do not include an empty option, it is added automatically. Returns `array` - The JHtml options for a drop-down filter Since 2.0

Magic methods summary

Properties summary

`protected string`	`$description`	# The description text for the form field. Usually used in tooltips. The description text for the form field. Usually used in tooltips. Since 2.0
`protected SimpleXMLElement`	`$element`	# The SimpleXMLElement object of the <field /> XML element that describes the header field. The SimpleXMLElement object of the <field /> XML element that describes the header field. Since 2.0
`protected FOFForm`	`$form`	# The FOFForm object of the form attached to the header field. The FOFForm object of the form attached to the header field. Since 2.0
`protected string`	`$label`	# The label for the header field. The label for the header field. Since 2.0
`protected string\|null`	`$header`	# The header HTML. The header HTML. Since 2.0
`protected string\|null`	`$filter`	# The filter HTML. The filter HTML. Since 2.0
`protected string\|null`	`$buttons`	# The buttons HTML. The buttons HTML. Since 2.0
`protected array\|null`	`$options`	# The options for a drop-down filter. The options for a drop-down filter. Since 2.0
`protected string`	`$name`	# The name of the form field. The name of the form field. Since 2.0
`protected string`	`$fieldname`	# The name of the field. The name of the field. Since 2.0
`protected string`	`$group`	# The group of the field. The group of the field. Since 2.0
`protected string`	`$type`	# The form field type. The form field type. Since 2.0
`protected mixed`	`$value`	# The value of the filter. The value of the filter. Since 2.0
`protected mixed`	`$tdwidth`	# The intended table data width (in pixels or percent). The intended table data width (in pixels or percent). Since 2.0
`protected mixed`	`$filterSource`	# The key of the filter value in the model state. The key of the filter value in the model state. Since 2.0
`protected boolean`	`$sortable`	# Is this a sortable column? Is this a sortable column? Since 2.0

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFFormHeader

Direct known subclasses

Indirect known subclasses

Methods summary

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Returns

Parameters

Returns

Returns

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Magic methods summary

Properties summary

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since