\FOFFormHeaderFieldsearchable

Generic field header, with text input (search) filter

Synopsis

class FOFFormHeaderFieldsearchable extends FOFFormHeaderField {

• // Inherited members from FOFFormHeader
• protected  $description;
• protected SimpleXMLElement  $element;
• protected FOFForm  $form;
• protected  $label;
• protected string|null  $header;
• protected string|null  $filter;
• protected string|null  $buttons;
• protected array|null  $options;
• protected  $name;
• protected  $fieldname;
• protected  $group;
• protected  $type;
• protected  $value;
• protected  $tdwidth;
• protected  $filterSource;
• protected bool  $sortable;
• // methods
• protected string getFilter()
• protected string getButtons()
• // Inherited methods from FOFFormHeaderField
• protected string getHeader()
• // Inherited methods from FOFFormHeader
• public void __construct()
• public mixed __get()
• public FOFFormHeader setForm()
• public boolean setup()
• protected string getId()
• protected string getName()
• protected string getFieldName()
• protected string getLabel()
• protected mixed getValue()
• protected string getFilterSource()
• protected boolean getSortable()
• protected string|null getHeader()
• protected string|null getFilter()
• protected string|null getButtons()
• protected array getOptions()
}


Hierarchy

Extends

• FOFFormHeaderField

Extended by

• FOFFormHeaderFiltersearchable

Members

protected

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

Methods

protected

• getButtons() — Get the buttons HTML code
• getFilter() — Get the filter field

Inherited from FOFFormHeaderField

protected

• getHeader() — Get the header

Inherited from FOFFormHeader

protected

• 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.
• getFieldName() — Method to get the field name used.
• 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.
• getFilterSource() — Return the key of the filter value in the model state or, if it's not set, the name of the field.
• getHeader() — Returns the HTML for the header row, or null if this element should render no header element
• getId() — Method to get the id used for the field input tag.
• getLabel() — Method to get the field label.
• getName() — Method to get the name used for the field input tag.
• getOptions() — Returns the JHtml options for a drop-down filter. Do not include an empty option, it is added automatically.
• getSortable() — Is this a sortable field?
• getValue() — Get the filter value for this header field

public

• __get() — Method to get certain otherwise inaccessible properties from the form field object.
• setForm() — Method to attach a JForm object to the field.
• setup() — Method to attach a FOFForm object to the field.