Class ItemListField

This class describes the field displayed in a smart list. All properties of an instance of this class can be scalar, or a function taking as arguments : - $value The value of the cell - $field The field itself - $line All the values in the list results line

Namespace: Hawk
Package: List
Located at ItemListField.php

Methods summary

`public`	# `__construct( string $name, array $param, Hawk\ItemList $list )` Constructor Constructor Parameters `$name` The field name `$param` The field parameters `$list` The list the field is associated with
`public string`	# `getSearchCondition( array & $binds )` Get the Search SQL expression on this field Get the Search SQL expression on this field Parameters `$binds` The binded values, passe by reference that will be filled Returns string The SQL expression for the search on this field
`public Hawk\FormInput`	# `getInput( )` Get the input corresponding to the field Get the input corresponding to the field Returns `Hawk\FormInput` the input instance
`public string`	# `displaySearchInput( )` Display the search field in the list header Display the search field in the list header Returns string The HTML result to display
`public string`	# `displayHeader( )` Display the field header Display the field header Returns string The HTML result to display
`public string`	# `displayCell( array $lineIndex )` Get the displayed value Get the displayed value Parameters `$lineIndex` The index of the line in the list results to display Returns string The HTML result to display

Properties summary

`public`	`$name` The name of the field in the list. Must be unique for each field in a list The name of the field in the list. Must be unique for each field in a list	#
`public string`	`$field` The field name in the search table The field name in the search table	# `null`
`public string\|callable`	`$class` The class attribute to add to the result cell The class attribute to add to the result cell	# `null`
`public string\|callable`	`$title` The 'title' attribute on hover on the cell The 'title' attribute on hover on the cell	# `null`
`public string\|callable`	`$href` This property, if set, will permit to open the set URL in the target defined by the property $target on a click event This property, if set, will permit to open the set URL in the target defined by the property $target on a click event	# `null`
`public string\|callable`	`$target` The target where to open the URL defined in $href property The target where to open the URL defined in $href property	# `null`
`public string\|callable`	`$onclick` The 'onclick' attribute The 'onclick' attribute	# `null`
`public string\|callable`	`$style` The 'style' attribute The 'style' attribute	# `null`
`public string\|callable`	`$unit` A unit to add after the value of the cell A unit to add after the value of the cell	# `null`
`public string\|callable`	`$display` Define if you want a specific displaying for this cell Define if you want a specific displaying for this cell	# `null`
`public boolean`	`$sort` Display the widgets to sort the list by this field values Display the widgets to sort the list by this field values	# `true`
`public string`	`$sortValue` The sort value The sort value	# `null`
`public boolean`	`$search` Displays the serach input for this field Displays the serach input for this field	# `true`
`public string`	`$searchValue` The search value The search value	# `null`
`public boolean`	`$independant` If set to true, this field will not be searched in the database If set to true, this field will not be searched in the database	# `false`
`public string`	`$label` The label to display in the list header The label to display in the list header	# `null`
`public boolean`	`$hidden` If set to true, this field will appear in the DOM, but wille be not visible If set to true, this field will appear in the DOM, but wille be not visible	# `false`
`public Hawk\ItemList`	`$list` The list the field is associated with The list the field is associated with	# `null`

Namespaces

Classes

Traits

Exceptions

Class ItemListField

Methods summary

Parameters

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Properties summary