• Home
• FOF30
• Form
• Header
• HeaderBase

PHP Class FOF30\Form\Header\HeaderBase

Show file Open project: akeeba/fof

Protected Properties

Property	Type	Description
$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 XML element that describes the header field.
$fieldname	string	The name of the field.
$filter	string | null	The filter HTML.
$filterFieldName	mixed	The name of the filter field
$filterSource	mixed	The key of the filter value in the model state.
$form	FOF30\Form\Form	The Form 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.
$onlyFilter	boolean	Should we ignore the header (have the field act as just a filter)?
$options	array | null	The options for a drop-down filter.
$sortable	boolean	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.

Public Methods

Method	Description
__construct ( Form $form = null )	Method to instantiate the form field object.
__get ( string $name ) : mixed	Method to get certain otherwise inaccessible properties from the form field object.
setForm ( Form $form ) : FOF30\Form\HeaderInterface	Method to attach a JForm object to the field.
setup ( SimpleXMLElement $element, string $group = null ) : boolean	Method to attach a Form object to the field.

Protected Methods

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

Method Details

Property Details