\Fuman_InputType_Configuration

__construct()

__construct(integer|string  $fumanId, string  $uniqueName, \Fuman_Table  $table, null|string  $columnName = null, null|\stdClass  $config = null, null|\stdClass  $record = null) 

Constructor Internally calls _createColumn, then _init

Parameters

init()

init() : void

Init Call _initFromProperties, _initFromConfig

setDefaultValues()

setDefaultValues(\Fuman_Db_Record  $record) 

Sets default values

Parameters

getFilterComponent()

getFilterComponent() : \Fuman_InputType_Filter_Abstract

Gets filter component for input type

Returns

isFilterable()

isFilterable() : boolean

Is input type filterable

Returns

getFormComponent()

getFormComponent(\Fuman_Db_Record  $record, string|null  $language = null, \Fuman_Form_Model_Abstract  $formModel = null) : \Fuman_InputType_Element

Return Form Component

Parameters

Returns

getViewComponent()

getViewComponent(\Fuman_Db_Record  $record, string|null  $language = null, \Fuman_Form_Model_Abstract  $formModel = null) : \Fuman_InputType_View

Gets view component

Parameters

Returns

setHelpMessages()

setHelpMessages(\Fuman_InputType_Renderer_Abstract  $renderer) 

Sets help messages

Parameters

getFormName()

getFormName(\Fuman_Db_Record|null  $record, string|null  $language = null, string|null  $formNameSuffix = null, boolean  $compute = false) : string

Returns formname of inputtype

Parameters

Returns

getKey()

getKey(\Fuman_Db_Record  $record, string  $language = null, string  $keySuffix = null) : string

Parameters

Returns

getText()

getText(\Fuman_Db_Record  $record, string|null  $language = null) : string

Gets text (text only representation of input type)

Parameters

Returns

collectText()

collectText(\Fuman_Db_Record  $record, integer  $collectionType, string  $language, boolean  $forHtml, integer|null  $depth, \stdClass|null  $visitedRecords = null) : string

Collects text

Parameters

Returns

getListComponent()

getListComponent(\Fuman_Db_Record  $record, \Fuman_Db_RecordSet  $recordSet, string|null  $language = null) : string

Gets list component (by default this will call getText)

Parameters

Returns

getListComponentAssets()

getListComponentAssets(\Fuman_Response_Data  $data, \Fuman_Db_RecordSet  $recordSet) : null

Get assets for list of this input type

Parameters

Returns

initConfigByRequest()

initConfigByRequest(\Fuman_Request  $request, \Fuman_Form_Model_Basic  $formModel, \Fuman_Db_Record  $record) 

Init config by request

Parameters

prepareConfig()

prepareConfig(\Fuman_Form_Model_Basic  $formModel) : void

Prepare config component

Parameters

initByRequest()

initByRequest(\Fuman_Request  $request, \Fuman_Db_Record  $record) : void

Validate configuration by validators and by asking the inputtype

Parameters

setValue()

setValue(mixed  $value, \Fuman_Db_Record  $record, string|null  $language = null) 

Sets value

Parameters

recordValidate()

recordValidate(\Fuman_Db_Record  $record) : void

Record validate

Parameters

recordPreSave()

recordPreSave(\Fuman_Db_Record  $record) : void

Record pre save

Parameters

recordPostSave()

recordPostSave(\Fuman_Db_Record  $record) : void

Inform inputtype, when config is saved

Parameters

recordPreDelete()

recordPreDelete(\Fuman_Db_Record  $record) : void

Record pre delete

Parameters

recordPostDelete()

recordPostDelete(\Fuman_Db_Record  $record) : void

Record post delete

Parameters

prepareRecordSetMeta()

prepareRecordSetMeta(\Fuman_Db_RecordSetMeta  $meta) : void

Prepare RecordSetMeta

Parameters

getTemplateDataLanguage()

getTemplateDataLanguage(\Fuman_Db_Record  $record, boolean  $fallback = true) : string

Returns the language of the data returned by getTemplateData

Parameters

Returns

getTemplateData()

getTemplateData(\Fuman_Db_Record  $record, string|null  $language = null) : mixed|string

Gets front end text (text only representation of input type)

Parameters

Returns

getValidationGroupColumnNames()

getValidationGroupColumnNames() : array|null

Returns an array of column names which can be used in validation groups

Returns

getTemplateUsages()

getTemplateUsages() : array<mixed,\Fuman_Template_InputTypeUsage>

Gets usage for templating

Returns

getInlineHtmlAttribute()

getInlineHtmlAttribute(string  $language, \Fuman_Db_Record  $record, \Fuman_Response_Data  $response, string|null  $title = null) : string

Gets inline html attributes

Parameters

Returns

getInlineJavaScriptClass()

getInlineJavaScriptClass() : null

Gets the inline javascript class

Returns

getInlineJavaScriptOptions()

getInlineJavaScriptOptions(\Fuman_Db_Record  $record, string  $language, \Fuman_Response_Data  $response) : object

Gets the inline javascript class options

Parameters

Returns

getMainColumn()

getMainColumn() : \Fuman_Column|\Fuman_Column_ManyToMany|\Fuman_Column_ManyToOne|\Fuman_Column_OneToMany

Returns the main column of an inputtype

Returns

hasMainColumn()

hasMainColumn() : boolean

Has the inputType a min column

Returns

getConfigValue()

getConfigValue(string  $key) : mixed

Get config value

Parameters

Returns

hasConfigValue()

hasConfigValue(string  $key) : string

Returns true when config value is set

Parameters

Returns

hasConfigValues()

hasConfigValues() : boolean

Returns true when all keys are set

Returns

setConfigValue()

setConfigValue(string  $key, string  $value) : void

Set Config Value

Parameters

getConfigValueOrDefault()

getConfigValueOrDefault(string  $key, mixed|null  $default = null) : mixed

Returns a config value or default

Parameters

Returns

getFumanId()

getFumanId() : integer|null

Get fuman Id

Returns

setFumanId()

setFumanId(integer|string  $fumanId) : void

Set fuman id

Parameters

getUniqueName()

getUniqueName() : string

Get uniquename

Returns

setUniqueName()

setUniqueName(string  $uniqueName) : void

Set uniquename

Parameters

getColumnName()

getColumnName(string|null  $language = null, string|null  $columnNameSuffix = null) : string

Get column name

Parameters

Returns

hasColumnName()

hasColumnName() : boolean

Has column name

Returns

setDisplayName()

setDisplayName(string  $displayName) : void

Set display name

Parameters

getDisplayName()

getDisplayName() : string

Get display name

Returns

setHtmlDisplayName()

setHtmlDisplayName(string  $htmlDisplayName) : void

Sets html display name (may include html tags)

Parameters

getHtmlDisplayName()

getHtmlDisplayName() : null|string

Gets html display name (Returns default display name if html display name not set)

Returns

setShowInOverview()

setShowInOverview(boolean  $showInOverview) : void

Set Show in Overview

Parameters

showInOverview()

showInOverview() : boolean

Get show in overview

Returns

showInSummary()

showInSummary() : boolean

Show in reference

Returns

setShowInSummary()

setShowInSummary(boolean  $showInSummary) : void

Sets flag to be shown in references

Parameters

setConfig()

setConfig(\stdClass  $config) : void

Set Config

Parameters

getConfig()

getConfig() : \stdClass

Get Config

Returns

getInputTypeRecord()

getInputTypeRecord() : \stdClass

Get input type record

Returns

isSearchable()

isSearchable() : boolean

Is searchable

Returns

getSearchIndexBreakPoints()

getSearchIndexBreakPoints() : null|array

Gets the search index break points

Returns

isRequired()

isRequired() : mixed

Is this inputtype required (layout * behind label)

Returns

isTranslatable()

isTranslatable() : boolean

Is translatable

Returns

hasTranslatableView()

hasTranslatableView() : boolean

its possible to draw this inputtype in a half width row

Returns

true

isOrderable()

isOrderable() : boolean

Is orderable

Returns

hasHelpMessage()

hasHelpMessage() : boolean

Has help message

Returns

getHelpMessage()

getHelpMessage() : null|string

Gets help message

Returns

setHelpMessage()

setHelpMessage(string  $message) 

Sets help message

Parameters

getTabName()

getTabName() : string

Gets tab name

Returns

getTranslatedTabName()

getTranslatedTabName(null|string  $tabName = null, boolean  $addInlineTranslationSpan = true) : string

Returns the translation value for tab key ('fuman_inputtype_tabname_'.$tabKey) if the parameter $tabKey is null, it uses the own methode getTabKey to fetch it.

this behaviour is used in the add Action

Parameters

Returns

getDataTypeFromConfig()

getDataTypeFromConfig(integer  $defaultType) : \Fuman_Db_DataType

Gets the datatype from config (datatype, datatype_length) or default

Parameters

Returns

collectSearchContent()

collectSearchContent(\Fuman_Db_Record  $record, \Fuman_Db_SearchContent  $searchContent, integer  $depth, string|null  $path = null) : void

Collects content for search index

Parameters

getColumns()

getColumns() : array<mixed,\Fuman_Column>

Returns a list of Columns

Returns

getColumn()

getColumn(string  $columnName) : \Fuman_Column

Gets column for name

Parameters

Returns

hasColumn()

hasColumn(string  $columnName) : boolean

Has column

Parameters

Returns

getTable()

getTable() : \Fuman_Table

Gets table

Returns

setTable()

setTable(\Fuman_Table  $table) : void

Sets table

Parameters

getSelectedInputTypeFormComponent()

getSelectedInputTypeFormComponent(\Fuman_Db_Record  $record, \stdClass  $data) : \Fuman_InputType_Renderer

Gets selected input type from component

Parameters

Returns

getFormModelFromRecord()

getFormModelFromRecord(\Fuman_Db_Record  $record, \Fuman_Request  $request = null) : \Fuman_Form_Model_Basic

Get Config Handler

Parameters

Throws

\Exception

Returns

getConfigByDbRecord()

getConfigByDbRecord(\Fuman_Db_Record  $record) : \stdClass

Get Fuman_InputType_Config by Fuman_Db_Record

Parameters

Returns

decodeConfig()

decodeConfig(string  $configText) : \stdClass

Decodes config (JSON)

Parameters

Returns

encodeConfig()

encodeConfig(\stdClass  $config) : float|null|string

Encodes config (JSON)

Parameters

Returns

getConfigurableFromRecord()

getConfigurableFromRecord(\Fuman_Db_Record  $record) : null|\Fuman_InputType|\Fuman_InputType_Configuration_Interface

Parameters

Returns

_initFromProperties()

_initFromProperties() : void

Initializes the inputtype with the properties from the inputTypeRecord

_initFromConfig()

_initFromConfig() : void

Initializes the inputtype by config Called at the end of the init process

_createMainColumn()

_createMainColumn(integer|\Fuman_Db_DataType  $dataType) : void

Creates and adds the main column

Parameters

_createTranslationColumn()

_createTranslationColumn(integer|\Fuman_Db_DataType  $dataType, string|null  $columnNameSuffix = null) : void

Creates and adds the translation columns if $this->isTranslatable() is true and it has some Content-Translation-Languages on the table

Parameters

_handleTranslatableColumnSuffix()

_handleTranslatableColumnSuffix() 

sets the suffix for the columnName and update the columnName if config value application.use_translatable_column_suffix is set or table has getUseTranslatableColumnSuffix and the inputType has no own translatableColumnSuffix defined

_initByRequest()

_initByRequest(\Fuman_Request  $request, \Fuman_Db_Record  $record, string|null  $nameSuffix = null) : void

Called before the record is saved

Parameters

_initByRequestAndLanguage()

_initByRequestAndLanguage(\Fuman_Request  $request, \Fuman_Db_Record  $record, string  $language, string|null  $nameSuffix = null) : void

Initializes record from request

Parameters

_getTemplateDataFallbackLanguage()

_getTemplateDataFallbackLanguage(\Fuman_Db_Record  $record, string|null  $language = null) : string

Returns the language to fallback to

Parameters

Returns

_getValueFromRecord()

_getValueFromRecord(\Fuman_Db_Record  $record, string|null  $language = null, string|null  $columnNameSuffix = null) : string|integer

Returns a value from record

Parameters

Returns

_getTranslatedName()

_getTranslatedName(string  $name, string  $language, string  $suffix = '') : string

Gets translations column/form name Returns the appropriate column/form name, also for content default language

Parameters

Returns

_getTabTranslationKey()

_getTabTranslationKey(string|null  $tabName = null) : string

Gets translation tab key

Parameters

Returns

_createColumns()

_createColumns() : void

Create columns

_addColumn()

_addColumn(\Fuman_Column  $column) : void

Adds column

Parameters

_collectClasses()

_collectClasses(string  $type, array<mixed,string>  $parentClassNames, boolean  $orderByText = true) : array

Collect classes for type

Parameters

Returns

_initConfigurableByRecord()

_initConfigurableByRecord(\Fuman_Db_Record  $record) : null|\Fuman_InputType|\Fuman_InputType_Configuration_Interface

Returns a instance of the class which should be configured by a record.

Parameters

Returns

_getClassType()

_getClassType() : string

To search all class files, which should be displayed, the class-type has to be provided by the concrete class.

Returns

_getClassTypeParents()

_getClassTypeParents() : array<mixed,string>

Gets class type parents

Returns

_getTemplatePath()

_getTemplatePath() : void

Returns template path of the concrete-class.