PHP 클래스 FOF30\Form\Header\HeaderBase

부터: 2.0
파일 보기 프로젝트 열기: akeeba/fof

보호된 프로퍼티들

프로퍼티 타입 설명
$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