Constants

VALUETYPES

VALUETYPES = array('lookup', 'lookup-all', 'const', 'count', 'sum')

BTNCLASSES

BTNCLASSES = array('default', 'primary', 'info', 'success', 'danger', 'warning', 'accent')

Properties

$value

$value : 

Type

$label

$label : 

Type

$onList

$onList : 

Type

$onCard

$onCard : 

Type

$onUpdate

$onUpdate : 

Type

$faIcon

$faIcon : 

Type

$btnClass

$btnClass : 

Type

$position

$position : 

Type

$fieldname

$fieldname : 

Type

$enabled

$enabled : 

Type

$visible

$visible : 

Type

$tableFieldname

$tableFieldname : 

Type

$pageId

$pageId : 

Type

$cardPage

$cardPage : 

Type

$valueType

$valueType : 

Type

$drillDownLink

$drillDownLink : 

Type

$drillDownTarget

$drillDownTarget : 

Type

$lookupAllSeparator

$lookupAllSeparator : 

Type

$overrideDrillDownLink

$overrideDrillDownLink : 

Type

Methods

__construct()

__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

Parameters

\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'

Returns

\Alddesign\Crudkit\Classes\Lookup

calculateLookup()

calculateLookup(array  $record, \Alddesign\Crudkit\Classes\bool  $calculateLink = true) : void

Calculates the values of the lookup field

Parameters

array $record

The source record

\Alddesign\Crudkit\Classes\bool $calculateLink

getDrillDownLink()

getDrillDownLink(array  $record) : string

Gets the link for the related page (card or list)

Parameters

array $record

The reference record

Returns

string

setValue()

setValue(\Alddesign\Crudkit\Classes\string  $value) : \Alddesign\Crudkit\Classes\Lookup

Set the value of the action/lookup on pages

Parameters

\Alddesign\Crudkit\Classes\string $value

Returns

\Alddesign\Crudkit\Classes\Lookup

setLabel()

setLabel(\Alddesign\Crudkit\Classes\string  $label) : \Alddesign\Crudkit\Classes\Lookup

Set the label of the action/lookup on pages

Parameters

\Alddesign\Crudkit\Classes\string $label

Returns

\Alddesign\Crudkit\Classes\Lookup

setOnList()

setOnList(\Alddesign\Crudkit\Classes\bool  $onList = true) : \Alddesign\Crudkit\Classes\Lookup

Show/hide on list pages.

Parameters

\Alddesign\Crudkit\Classes\bool $onList

Returns

\Alddesign\Crudkit\Classes\Lookup

setOnCard()

setOnCard(\Alddesign\Crudkit\Classes\bool  $onCard = true) : \Alddesign\Crudkit\Classes\Lookup

Show/hide on card pages.

Parameters

\Alddesign\Crudkit\Classes\bool $onCard

Returns

\Alddesign\Crudkit\Classes\Lookup

setOnUpdate()

setOnUpdate(\Alddesign\Crudkit\Classes\bool  $onUpdate = true) : \Alddesign\Crudkit\Classes\Lookup

Show/hides on update pages.

Parameters

\Alddesign\Crudkit\Classes\bool $onUpdate

Returns

\Alddesign\Crudkit\Classes\Lookup

setFaIcon()

setFaIcon(\Alddesign\Crudkit\Classes\string  $faIcon) : \Alddesign\Crudkit\Classes\Lookup

Sets the icon for the button (font awesome icon name)

Parameters

\Alddesign\Crudkit\Classes\string $faIcon

Returns

\Alddesign\Crudkit\Classes\Lookup

setBtnClass()

setBtnClass(\Alddesign\Crudkit\Classes\string  $btnClass = 'default') 

Defines the button appearance.

Admin LTE button type. ''|'default'|'primary'|'info'|'success'|'danger'|'warning'|'accent'

Parameters

\Alddesign\Crudkit\Classes\string $btnClass

setFieldname()

setFieldname(\Alddesign\Crudkit\Classes\string  $fieldname) : \Alddesign\Crudkit\Classes\Lookup

Set reference fieldname for $position

Parameters

\Alddesign\Crudkit\Classes\string $fieldname

Returns

\Alddesign\Crudkit\Classes\Lookup

setEnabled()

setEnabled(\Alddesign\Crudkit\Classes\bool  $enabled = true) : \Alddesign\Crudkit\Classes\Lookup

Enableds/disables the action

Parameters

\Alddesign\Crudkit\Classes\bool $enabled

Returns

\Alddesign\Crudkit\Classes\Lookup

setVisible()

setVisible(\Alddesign\Crudkit\Classes\bool  $visible = true) : \Alddesign\Crudkit\Classes\Lookup

Show/hide.

Parameters

\Alddesign\Crudkit\Classes\bool $visible

Returns

\Alddesign\Crudkit\Classes\Lookup

setTableFieldname()

setTableFieldname(\Alddesign\Crudkit\Classes\string  $tableFieldname) : \Alddesign\Crudkit\Classes\Lookup

Set the fieldname of the reference table (for lookup)

Parameters

\Alddesign\Crudkit\Classes\string $tableFieldname

Returns

\Alddesign\Crudkit\Classes\Lookup

setPosition()

setPosition(\Alddesign\Crudkit\Classes\string  $position) : \Alddesign\Crudkit\Classes\Lookup

Set the position of the lookup 'before-field', 'after-field', 'to-field'

Parameters

\Alddesign\Crudkit\Classes\string $position

Returns

\Alddesign\Crudkit\Classes\Lookup

setPageId()

setPageId(\Alddesign\Crudkit\Classes\string  $pageId) : \Alddesign\Crudkit\Classes\Lookup

Set the drilldown pageId

Parameters

\Alddesign\Crudkit\Classes\string $pageId

Returns

\Alddesign\Crudkit\Classes\Lookup

setCardPage()

setCardPage(\Alddesign\Crudkit\Classes\bool  $cardPage) : \Alddesign\Crudkit\Classes\Lookup

Set if the drilldown Page is a cardpage

Parameters

\Alddesign\Crudkit\Classes\bool $cardPage

Returns

\Alddesign\Crudkit\Classes\Lookup

setValueType()

setValueType(\Alddesign\Crudkit\Classes\string  $valueType) : \Alddesign\Crudkit\Classes\Lookup

Set the value type lookup', 'lookup-all', 'const', 'count', 'sum'

Parameters

\Alddesign\Crudkit\Classes\string $valueType

Returns

\Alddesign\Crudkit\Classes\Lookup

setDrillDownTarget()

setDrillDownTarget(\Alddesign\Crudkit\Classes\string  $drillDownTarget) : \Alddesign\Crudkit\Classes\Lookup

Set the target for the drilldown link (_blank, _self, _parent, _top). Default is _self

Parameters

\Alddesign\Crudkit\Classes\string $drillDownTarget

Returns

\Alddesign\Crudkit\Classes\Lookup

setDrillDownLink()

setDrillDownLink(string  $drillDownLink, boolean  $override = true) : \Alddesign\Crudkit\Classes\Lookup

Set the drilldown link maunally

Parameters

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

Returns

\Alddesign\Crudkit\Classes\Lookup

setLookupAllSeparator()

setLookupAllSeparator(\Alddesign\Crudkit\Classes\string  $lookupAllSeparator) : \Alddesign\Crudkit\Classes\Lookup

Set the separator string for $valueType

Parameters

\Alddesign\Crudkit\Classes\string $lookupAllSeparator

Returns

\Alddesign\Crudkit\Classes\Lookup