Docs For Class FOFFormHeader

FOFFormHeader

Description

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

abstract:
since: 2.0

Located in /libraries/fof/form/header.php (line 18)

Direct descendents

Class	Description
FOFFormHeaderField	Generic field header, without any filters
FOFFormHeaderOrdering	Ordering field header
FOFFormHeaderRowselect	Row selection checkbox

Variable Summary

string|null $buttons

string $description

SimpleXMLElement $element

string $fieldname

string|null $filter

mixed $filterSource

FOFForm $form

string $group

string|null $header

string $label

string $name

array|null $options

bool $sortable

mixed $tdwidth

string $type

mixed $value

Method Summary

FOFFormHeader __construct ([FOFForm $form = null])

string|null getButtons ()

string getFieldName (string $fieldName)

string|null getFilter ()

string getFilterSource (string $filterSource)

string|null getHeader ()

string getId (string $fieldId, string $fieldName)

string getLabel ()

string getName (string $fieldName)

array getOptions ()

boolean getSortable ()

mixed getValue ()

FOFFormHeader setForm (FOFForm $form)

boolean setup (SimpleXMLElement $element, mixed $value, [string $group = null])

mixed __get (string $name)

Variables

string|null $buttons (line 74)

The buttons HTML.

since: 2.0
access: protected

string $description (line 26)

The description text for the form field. Usually used in tooltips.

since: 2.0
access: protected

SimpleXMLElement $element (line 34)

The SimpleXMLElement object of the <field /> XML element that describes the header field.

since: 2.0
access: protected

string $fieldname (line 98)

The name of the field.

since: 2.0
access: protected

string|null $filter (line 66)

The filter HTML.

since: 2.0
access: protected

mixed $filterSource (line 138)

The key of the filter value in the model state.

since: 2.0
access: protected

FOFForm $form (line 42)

The FOFForm object of the form attached to the header field.

since: 2.0
access: protected

string $group (line 106)

The group of the field.

since: 2.0
access: protected

string|null $header (line 58)

The header HTML.

since: 2.0
access: protected

string $label (line 50)

The label for the header field.

since: 2.0
access: protected

string $name (line 90)

The name of the form field.

since: 2.0
access: protected

array|null $options (line 82)

The options for a drop-down filter.

since: 2.0
access: protected

bool $sortable = false (line 146)

Is this a sortable column?

since: 2.0
access: protected

mixed $tdwidth (line 130)

The intended table data width (in pixels or percent).

since: 2.0
access: protected

string $type (line 114)

The form field type.

since: 2.0
access: protected

mixed $value (line 122)

The value of the filter.

since: 2.0
access: protected

Methods

Constructor __construct (line 155)

Method to instantiate the form field object.

since: 2.0
access: public

FOFFormHeader __construct ([FOFForm $form = null])

FOFForm $form: The form to attach to the form field object.

getButtons (line 562)

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.

return: HTML code or null if nothing is to be rendered
since: 2.0
access: protected

string|null getButtons ()

Redefined in descendants as:

FOFFormHeaderFielddate::getButtons() : Get the buttons HTML code
FOFFormHeaderFieldsearchable::getButtons() : Get the buttons HTML code

getFieldName (line 437)

Method to get the field name used.

return: The field name
since: 2.0
access: protected

string getFieldName (string $fieldName)

string $fieldName: The field element name.

getFilter (line 548)

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.

return: HTML code or null if nothing is to be rendered
since: 2.0
access: protected

string|null getFilter ()

Redefined in descendants as:

FOFFormHeaderFielddate::getFilter() : Get the filter field
FOFFormHeaderFieldsearchable::getFilter() : Get the filter field

getFilterSource (line 493)

Return the key of the filter value in the model state or, if it's not set, the name of the field.

access: protected

string getFilterSource (string $filterSource)

string $filterSource: The filter source value to return

getHeader (line 535)

Returns the HTML for the header row, or null if this element should render no header element

return: HTML code or null if nothing is to be rendered
since: 2.0
access: protected

string|null getHeader ()

Redefined in descendants as:

FOFFormHeaderField::getHeader() : Get the header
FOFFormHeaderFiltersearchable::getHeader() : Get the header
FOFFormHeaderFiltersql::getHeader() : Get the header
FOFFormHeaderFilterselectable::getHeader() : Get the header
FOFFormHeaderOrdering::getHeader() : Get the header
FOFFormHeaderRowselect::getHeader() : Get the header

getId (line 339)

Method to get the id used for the field input tag.

return: The id to be used for the field input tag.
since: 2.0
access: protected

string getId (string $fieldId, string $fieldName)

string $fieldId: The field element id.
string $fieldName: The field element name.

getLabel (line 449)

Method to get the field label.

return: The field label.
since: 2.0
access: protected

string getLabel ()

getName (line 385)

Method to get the name used for the field input tag.

return: The name to be used for the field input tag.
since: 2.0
access: protected

string getName (string $fieldName)

string $fieldName: The field element name.

getOptions (line 575)

Returns the JHtml options for a drop-down filter. Do not include an empty option, it is added automatically.

return: The JHtml options for a drop-down filter
since: 2.0
access: protected

array getOptions ()

Redefined in descendants as:

FOFFormHeaderFieldselectable::getOptions() : Create objects for the options
FOFFormHeaderAccesslevel::getOptions() : Method to get the list of access levels
FOFFormHeaderFieldsql::getOptions() : Create objects for the options
FOFFormHeaderLanguage::getOptions() : Method to get the filter options.
FOFFormHeaderModel::getOptions() : Method to get the field options.
FOFFormHeaderPublished::getOptions() : Create objects for the options

getSortable (line 510)

Is this a sortable field?

return: True if it's sortable
access: protected

boolean getSortable ()

getValue (line 478)

Get the filter value for this header field

return: The filter value
access: protected

mixed getValue ()

setForm (line 261)

Method to attach a JForm object to the field.

return: The form field object so that the method can be used in a chain.
since: 2.0
access: public

FOFFormHeader setForm (FOFForm $form)

FOFForm $form: The JForm object to attach to the form field.

setup (line 281)

Method to attach a FOFForm object to the field.

return: True on success.
since: 2.0
access: public

boolean setup (SimpleXMLElement $element, mixed $value, [string $group = null])

SimpleXMLElement $element: The SimpleXMLElement object representing the <field /> tag for the form field object.
mixed $value: The form field value to validate.
string $group: The field name group control value. This acts as 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]".

__get (line 173)

Method to get certain otherwise inaccessible properties from the form field object.

return: The property value or null.
since: 2.0
access: public

mixed __get (string $name)

string $name: The property name for which to the the value.

Documentation generated on Tue, 19 Nov 2013 15:04:14 +0100 by phpDocumentor 1.4.3