POSITIONS
POSITIONS = array('before-field', 'after-field', 'to-field')
A lookup is a calculated field with values from other tables or fixed values
$filterDefinitions : array<mixed,\Alddesign\Crudkit\Classes\FilterDefinition>
$table : \Alddesign\Crudkit\Classes\TableDescriptor
__construct(\Alddesign\Crudkit\Classes\TableDescriptor $table, string $tableFieldname, array $filterDefinitions, string $valueType, string $label, string $position, string $fieldname, \Alddesign\Crudkit\Classes\string $pageId = '', boolean $cardPage = false, string $value = '') : \Alddesign\Crudkit\Classes\Lookup
Creates a Lookup
| \Alddesign\Crudkit\Classes\TableDescriptor | $table | the reference table for the lookup |
| string | $tableFieldname | the fieldname in the recerence table |
| array | $filterDefinitions | fitlers for the reference talbe |
| string | $valueType | Defindes whats the value of the label (that is displayed)'lookup', 'lookup-all', 'const', 'count', 'sum' |
| string | $label | The text of the label for the action |
| string | $position | Position on card page. 'before-field', 'after-field', 'to-field' |
| string | $fieldname | The reference field for $position |
| \Alddesign\Crudkit\Classes\string | $pageId | |
| boolean | $cardPage | Shows the related record in a card page (fitlers have to return exactly one record!) |
| string | $value | The value for $valueType 'const' |
setValue(\Alddesign\Crudkit\Classes\string $value) : \Alddesign\Crudkit\Classes\Lookup
Set the value of the action/lookup on pages
| \Alddesign\Crudkit\Classes\string | $value |
setLabel(\Alddesign\Crudkit\Classes\string $label) : \Alddesign\Crudkit\Classes\Lookup
Set the label of the action/lookup on pages
| \Alddesign\Crudkit\Classes\string | $label |
setOnList(\Alddesign\Crudkit\Classes\bool $onList = true) : \Alddesign\Crudkit\Classes\Lookup
Show/hide on list pages.
| \Alddesign\Crudkit\Classes\bool | $onList |
setOnCard(\Alddesign\Crudkit\Classes\bool $onCard = true) : \Alddesign\Crudkit\Classes\Lookup
Show/hide on card pages.
| \Alddesign\Crudkit\Classes\bool | $onCard |
setOnUpdate(\Alddesign\Crudkit\Classes\bool $onUpdate = true) : \Alddesign\Crudkit\Classes\Lookup
Show/hides on update pages.
| \Alddesign\Crudkit\Classes\bool | $onUpdate |
setFaIcon(\Alddesign\Crudkit\Classes\string $faIcon) : \Alddesign\Crudkit\Classes\Lookup
Sets the icon for the button (font awesome icon name)
| \Alddesign\Crudkit\Classes\string | $faIcon |
setFieldname(\Alddesign\Crudkit\Classes\string $fieldname) : \Alddesign\Crudkit\Classes\Lookup
Set reference fieldname for $position
| \Alddesign\Crudkit\Classes\string | $fieldname |
setEnabled(\Alddesign\Crudkit\Classes\bool $enabled = true) : \Alddesign\Crudkit\Classes\Lookup
Enableds/disables the action
| \Alddesign\Crudkit\Classes\bool | $enabled |
setVisible(\Alddesign\Crudkit\Classes\bool $visible = true) : \Alddesign\Crudkit\Classes\Lookup
Show/hide.
| \Alddesign\Crudkit\Classes\bool | $visible |
setTable(\Alddesign\Crudkit\Classes\TableDescriptor $table) : \Alddesign\Crudkit\Classes\Lookup
Set the reference table
| \Alddesign\Crudkit\Classes\TableDescriptor | $table |
setTableFieldname(\Alddesign\Crudkit\Classes\string $tableFieldname) : \Alddesign\Crudkit\Classes\Lookup
Set the fieldname of the reference table (for lookup)
| \Alddesign\Crudkit\Classes\string | $tableFieldname |
setPosition(\Alddesign\Crudkit\Classes\string $position) : \Alddesign\Crudkit\Classes\Lookup
Set the position of the lookup 'before-field', 'after-field', 'to-field'
| \Alddesign\Crudkit\Classes\string | $position |
setPageId(\Alddesign\Crudkit\Classes\string $pageId) : \Alddesign\Crudkit\Classes\Lookup
Set the drilldown pageId
| \Alddesign\Crudkit\Classes\string | $pageId |
setCardPage(\Alddesign\Crudkit\Classes\bool $cardPage) : \Alddesign\Crudkit\Classes\Lookup
Set if the drilldown Page is a cardpage
| \Alddesign\Crudkit\Classes\bool | $cardPage |
addFilterDefinitiona(\Alddesign\Crudkit\Classes\FilterDefinition $filterDefinition) : \Alddesign\Crudkit\Classes\Lookup
Add a filter definitinon for the reference table
| \Alddesign\Crudkit\Classes\FilterDefinition | $filterDefinition |
setValueType(\Alddesign\Crudkit\Classes\string $valueType) : \Alddesign\Crudkit\Classes\Lookup
Set the value type lookup', 'lookup-all', 'const', 'count', 'sum'
| \Alddesign\Crudkit\Classes\string | $valueType |
setDrillDownTarget(\Alddesign\Crudkit\Classes\string $drillDownTarget) : \Alddesign\Crudkit\Classes\Lookup
Set the target for the drilldown link (_blank, _self, _parent, _top). Default is _self
| \Alddesign\Crudkit\Classes\string | $drillDownTarget |
setDrillDownLink(string $drillDownLink, boolean $override = true) : \Alddesign\Crudkit\Classes\Lookup
Set the drilldown link maunally
| string | $drillDownLink | |
| boolean | $override | If this is set to true, the lookup will always take the link you provide instead of calculating one base on the table and filters |
setLookupAllSeparator(\Alddesign\Crudkit\Classes\string $lookupAllSeparator) : \Alddesign\Crudkit\Classes\Lookup
Set the separator string for $valueType
| \Alddesign\Crudkit\Classes\string | $lookupAllSeparator |