PHP Класс FOF30\Form\Header\HeaderBase

С версии: 2.0
Показать файл Открыть проект

Защищенные свойства (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 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.

Открытые методы

Метод Описание
__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.

Защищенные методы

Метод Описание
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

Описание методов

__construct() публичный метод

Method to instantiate the form field object.
С версии: 2.0
public __construct ( Form $form = null )
$form FOF30\Form\Form The form to attach to the form field object.

__get() публичный метод

Method to get certain otherwise inaccessible properties from the form field object.
С версии: 2.0
public __get ( string $name ) : mixed
$name string The property name for which to the the value.
Результат mixed The property value or 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.
С версии: 2.0
protected getButtons ( ) : string | null
Результат string | null HTML code or null if nothing is to be rendered

getFieldName() защищенный метод

Method to get the field name used.
С версии: 2.0
protected getFieldName ( string $fieldName ) : string
$fieldName string The field element name.
Результат string The field name

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.
С версии: 2.0
protected getFilter ( ) : string | null
Результат string | null HTML code or null if nothing is to be rendered

getFilterFieldName() защищенный метод

Return the name of the filter field
protected getFilterFieldName ( string $filterFieldName ) : string
$filterFieldName string The filter field name source value to return
Результат string

getFilterSource() защищенный метод

Return the key of the filter value in the model state or, if it's not set, the name of the field.
protected getFilterSource ( string $filterSource ) : string
$filterSource string The filter source value to return
Результат string

getHeader() защищенный метод

Returns the HTML for the header row, or null if this element should render no header element
С версии: 2.0
protected getHeader ( ) : string | null
Результат string | null HTML code or null if nothing is to be rendered

getId() защищенный метод

Method to get the id used for the field input tag.
С версии: 2.0
protected getId ( string $fieldId, string $fieldName ) : string
$fieldId string The field element id.
$fieldName string The field element name.
Результат string The id to be used for the field input tag.

getLabel() защищенный метод

Method to get the field label.
С версии: 2.0
protected getLabel ( ) : string
Результат string The field label.

getName() защищенный метод

Method to get the name used for the field input tag.
С версии: 2.0
protected getName ( string $fieldName ) : string
$fieldName string The field element name.
Результат string The name to be 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.
С версии: 2.0
protected getOptions ( ) : array
Результат array The JHtml options for a drop-down filter

getSortable() защищенный метод

Is this a sortable field?
protected getSortable ( ) : boolean
Результат boolean True if it's sortable

getValue() защищенный метод

Get the filter value for this header field
protected getValue ( ) : mixed
Результат mixed The filter value

setForm() публичный метод

Method to attach a JForm object to the field.
С версии: 2.0
public setForm ( Form $form ) : FOF30\Form\HeaderInterface
$form FOF30\Form\Form The JForm object to attach to the form field.
Результат FOF30\Form\HeaderInterface The form field object so that the method can be used in a chain.

setup() публичный метод

Method to attach a Form object to the field.
С версии: 2.0
public setup ( SimpleXMLElement $element, string $group = null ) : boolean
$element SimpleXMLElement The SimpleXMLElement object representing the tag for the form field object.
$group string 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]".
Результат boolean True on success.

Описание свойств

$buttons защищенное свойство

The buttons HTML.
С версии: 2.0
protected string|null $buttons
Результат string | null

$description защищенное свойство

The description text for the form field. Usually used in tooltips.
С версии: 2.0
protected string $description
Результат string

$element защищенное свойство

The SimpleXMLElement object of the XML element that describes the header field.
С версии: 2.0
protected SimpleXMLElement $element
Результат SimpleXMLElement

$fieldname защищенное свойство

The name of the field.
С версии: 2.0
protected string $fieldname
Результат string

$filter защищенное свойство

The filter HTML.
С версии: 2.0
protected string|null $filter
Результат string | null

$filterFieldName защищенное свойство

The name of the filter field
С версии: 3.0
protected mixed $filterFieldName
Результат mixed

$filterSource защищенное свойство

The key of the filter value in the model state.
С версии: 2.0
protected mixed $filterSource
Результат mixed

$form защищенное свойство

The Form object of the form attached to the header field.
С версии: 2.0
protected Form,FOF30\Form $form
Результат FOF30\Form\Form

$group защищенное свойство

The group of the field.
С версии: 2.0
protected string $group
Результат string

$header защищенное свойство

The header HTML.
С версии: 2.0
protected string|null $header
Результат string | null

$label защищенное свойство

The label for the header field.
С версии: 2.0
protected string $label
Результат string

$name защищенное свойство

The name of the form field.
С версии: 2.0
protected string $name
Результат string

$onlyFilter защищенное свойство

Should we ignore the header (have the field act as just a filter)?
С версии: 3.0
protected bool $onlyFilter
Результат boolean

$options защищенное свойство

The options for a drop-down filter.
С версии: 2.0
protected array|null $options
Результат array | null

$sortable защищенное свойство

Is this a sortable column?
С версии: 2.0
protected bool $sortable
Результат boolean

$tdwidth защищенное свойство

The intended table data width (in pixels or percent).
С версии: 2.0
protected mixed $tdwidth
Результат mixed

$type защищенное свойство

The form field type.
С версии: 2.0
protected string $type
Результат string

$value защищенное свойство

The value of the filter.
С версии: 2.0
protected mixed $value
Результат mixed