\Fuman_Table_Page

__construct()

__construct() : \Fuman_Table_System

Constructor

After instantiating a Table call \Fuman_Table::preInit() and Fuman_Table::init() to load all Fuman_Column and Fuman_InputType.

Note: Make sure that all needed Classes of the Framework are ready when you call init and preInit.

Returns

getDefaultActionNames()

getDefaultActionNames() : array

Returns an array of default actions for this table

Returns

getDisplayName()

getDisplayName(boolean  $returnPlural = false) : string

Returns Display Name of Table

Parameters

Returns

getHtmlDisplayName()

getHtmlDisplayName(boolean  $returnPlural = false) : string

Gets html display name (may include html tags)

Parameters

Returns

addInputType()

addInputType(\Fuman_InputType  $inputType, boolean  $addColumns = true) : void

Add a {@link Fuman_InputType} to the {@link Fuman_Table}.

Parameters

getContentDefaultLanguage()

getContentDefaultLanguage() : string

Gets the default content language

Returns

getContentTranslationLanguages()

getContentTranslationLanguages() : array

Gets the translation languages

Returns

hasContentTranslationLanguage()

hasContentTranslationLanguage(string  $language) : boolean

Is the language defined as content language

Parameters

Returns

hasContentTranslationLanguages()

hasContentTranslationLanguages() : boolean

Are any content translation languages defined

Returns

getAllContentTranslationLanguages()

getAllContentTranslationLanguages() : array

Get all content translation languages (including default on first position)

Returns

getTranslationPrefix()

getTranslationPrefix() : null|string

Returns the translation prefix of the table

Returns

getConfiguredDbName()

getConfiguredDbName(string  $tableUniqueName) : string

Gets configured db name

Parameters

Throws

\Exception

Returns

init()

init() : void

Init

getName()

getName() : string

Returns the table name

Returns

getSelectSql()

getSelectSql() : string

Returns the select sql

Returns

setSelectSql()

setSelectSql(  $selectSql) 

Sets the select sql

Parameters

setDisplayName()

setDisplayName(string  $displayName) : void

Set Display Name of Table

Parameters

setPluralDisplayName()

setPluralDisplayName(string  $pluralDisplayName) : void

Sets plural display name of table

Parameters

setHtmlDisplayName()

setHtmlDisplayName(string  $htmlDisplayName) : void

Display name which may include html tags

Parameters

setHtmlPluralDisplayName()

setHtmlPluralDisplayName(string  $htmlPluralDisplayName) : void

Sets plural display name which may include html tags.

Parameters

addAccessController()

addAccessController(\Fuman_Db_Record_AccessController  $controller) : void

Adds an access controller

Parameters

removeAccessController()

removeAccessController(\Fuman_Db_Record_AccessController  $controller) : void

Removes access controller

Parameters

isActionAllowedForRecord()

isActionAllowedForRecord(string  $actionClassName, \Fuman_Db_Record  $record) : boolean

Is action allowed for record

Parameters

Returns

setReadOnly()

setReadOnly(boolean  $flag) 

Sets read only

Parameters

isReadOnly()

isReadOnly() : boolean

Is the table read only

Returns

setHashProtected()

setHashProtected(boolean  $flag) 

Sets hash protected

Parameters

isHashProtected()

isHashProtected() : boolean

Is the table read only

Returns

setIconPath()

setIconPath(string  $path) : void

Set icon

Parameters

getIconPath()

getIconPath() : string

Get icon

Returns

hasIcon()

hasIcon() : boolean

Has icon

Returns

setUseTranslatableColumnSuffix()

setUseTranslatableColumnSuffix(boolean  $flag) 

Which mode should be used for translated input types

false: default_column, default_column_en, default_column_fr true: default_column_de, default_column_en, default_column_fr

Parameters

getUseTranslatableColumnSuffix()

getUseTranslatableColumnSuffix() 

Gets consistent translated column suffix

getPrimary()

getPrimary() : \Fuman_Column

Returns the {@link Fuman_Column} which is set as primary column.

Returns

hasPrimary()

hasPrimary() : boolean

Returns true when a {@link Fuman_Column} is set as primary column

Returns

getPrimaryName()

getPrimaryName() : string

Returns name of primary {@link Fuman_Column}.

Note: A primary Fuman_Column is optional. First check Fuman_Table::hasPrimary() before calling getPrimaryName.

Returns

getFumanId()

getFumanId() : integer

Returns id of {@link Fuman_Table}

Returns

getUniqueName()

getUniqueName(boolean  $getAclUniqueName = false) : string

Returns the unique-name of {@link Fuman_Table}

Parameters

Returns

setUniqueName()

setUniqueName(string  $uniqueName) : void

Set unique-name of {@link Fuman_Table}

Parameters

getDbName()

getDbName() : string

Returns the db name

Returns

setDbName()

setDbName(string  $dbName) : void

Sets the db name

Parameters

getDb()

getDb() : \Fuman_Db_Abstract

Returns {@link Fuman_Db_Abstract}.

Can be influenced when setting \Fuman_Table::setDbName($dbName) on Fuman_Table.

Returns

hasDb()

hasDb() : \Fuman_Db_Abstract

Checks if db available Can be influenced when setting {@link Fuman_Table::setDbName($dbName)} on {@link Fuman_Table}.

Returns

sqlJoin()

sqlJoin() : \Fuman_Db_SqlJoin

Gets Fuman_Db_SqlJoin

Returns

recordSaved()

recordSaved(\Fuman_Db_Record  $record) : void

Called when a record on this table has been saved

Parameters

recordDeleted()

recordDeleted(\Fuman_Db_Record  $record) : void

Called when a record on this table has been deleted

Parameters

addRecordListener()

addRecordListener(\Fuman_Db_Record_Listener  $listener) : void

Adds record listener

Parameters

removeRecordListener()

removeRecordListener(\Fuman_Db_Record_Listener  $listener) : void

Removes record listener

Parameters

hasInputType()

hasInputType(string  $uniqueName) : boolean

Returns true, when a {@link Fuman_InputType} with the given uniquename is set.

Parameters

Returns

getInputType()

getInputType(string  $uniqueName) : \Fuman_InputType

Returns a {@link Fuman_InputType} by uniquename.

Parameters

Returns

getInputTypesByClassName()

getInputTypesByClassName(string  $className) : array<mixed,\Fuman_InputType>|null

Return all inputtypes wich are assignable to $className (instanceof)

Parameters

Returns

getResponsibleContentBlockInputType()

getResponsibleContentBlockInputType(\Fuman_Db_Record  $record) : \app_core_inputtype_contentblock|null

Parameters

Returns

getInputTypes()

getInputTypes() : array<mixed,\Fuman_InputType>

Returns all {@link Fuman_InputType} of {@link Fuman_Table}

Returns

getShowInOverviewInputTypes()

getShowInOverviewInputTypes() : array<mixed,\Fuman_InputType>

Gets the overview input types (showInOverview). If none has been found and the $returnFirstAsDefault is true, the first inputType will be returned.

Returns

getShowInSummaryInputTypes()

getShowInSummaryInputTypes() : array<mixed,\Fuman_InputType>

Gets input types which should be shown in references. If none has been found and the $returnFirstAsDefault is true, the first inputType will be returned.

Returns

setSummaryTemplate()

setSummaryTemplate(string  $templateString) 

Sets summary template string

Parameters

getSummaryTemplate()

getSummaryTemplate() : string

Gets summary template string

Returns

getColumnCount()

getColumnCount() : integer

Returns the count of all added {@link Fuman_Column}.

Returns

getColumnNames()

getColumnNames() : array

Returns a list of {@link Fuman_Column} names.

Returns

getColumnDataType()

getColumnDataType(string  $columnName) : \Fuman_Db_DataType

Returns the dataType for columns

Parameters

Returns

getColumnDataTypes()

getColumnDataTypes() : array<mixed,\Fuman_Db_DataType>

Returns the dataType for columns

Returns

hasColumn()

hasColumn(string  $columnName) : boolean

Returns true when a {@link Fuman_Column} with the given name is set.

Parameters

Returns

isManyToManyTable()

isManyToManyTable() : boolean

Returns true when {@link Fuman_Table} is a many to many table.

Returns

setManyToManyTable()

setManyToManyTable(boolean  $flag) : void

Set flag on table whether the {@link Fuman_Table} is a many to many table or not.

Parameters

getParentUniqueName()

getParentUniqueName() : string

Returns uniquename of parent {@link Fuman_Table}

Returns

hasParent()

hasParent() : boolean

Returns true when {@link Fuman_Table} has a parent.

Returns

setParentUniqueName()

setParentUniqueName(string  $parentUniqueName) : void

Set uniquename of parent {@link Fuman_Table}

Parameters

setInheritedTable()

setInheritedTable(\Fuman_Table  $table) 

Sets the inherited table {@link Fuman_Table}

Parameters

hasInheritedTable()

hasInheritedTable() 

Returns true when an inherited table is set

getInheritedTable()

getInheritedTable() 

Returns the inherited table

setDynamicTable()

setDynamicTable(string  $columnName, string  $value) : void

Set dynamic flag and defines appropriate subset

Parameters

isDynamicTable()

isDynamicTable() : boolean

Returns true when a {@link Fuman_Table} is a dynamic Table

Returns

getDynamicTableColumnName()

getDynamicTableColumnName() : string

Gets the columnName of dynamic table

Returns

getDynamicTableColumnValue()

getDynamicTableColumnValue() : string

Gets the columnName of dynamic table

Returns

addSubset()

addSubset(\Fuman_Db_Where  $where) : void

Adds subset

Parameters

getSubset()

getSubset() : \Fuman_Db_Where

Gets subset

Returns

addSystemSubset()

addSystemSubset(\Fuman_Db_Where  $where) : void

Adds system subset (subsets used for dynamic tables, .

..)

Parameters

getSystemSubset()

getSystemSubset() : \Fuman_Db_Where

Gets the system subset subset (subsets used for dynamic tables, .

..)

Returns

useSystemSubsetOnly()

useSystemSubsetOnly(  $flag) 

Parameters

addChild()

addChild(\Fuman_Table  $child) : void

Add {@link Fuman_Table} as child

Parameters

getChildren()

getChildren() : array

Return all {@link Fuman_Table} which are added as children

Returns

hasChildren()

hasChildren() : boolean

Returns true when more than one child is added

Returns

addColumn()

addColumn(\Fuman_Column  $column) : void

Add a Column to the Table. A Column can be added multiple times on a Table, but just once with Write Access.

Parameters

Throws

\Fuman_Exception

Exception will be thrown when a {@link Fuman_Column} with write access was already added on the table.

removeColumn()

removeColumn(  $columnName) 

Removes column and its column data type

Parameters

getPreparedRecordSetMeta()

getPreparedRecordSetMeta(boolean  $considerRequestOrUserPreference = false) : \Fuman_Db_RecordSetMeta

Returns a {@link Fuman_Db_RecordSetMeta} which got prepared by the {{@link Fuman_InputType} of the {@link Fuman_Table}.

Parameters

Returns

addInputTypes()

addInputTypes() : void

Add a list of {@link Fuman_InputType} to the {@link Fuman_Table}

Throws

\Fuman_Exception

Thrown when being called without an argument

removeInputType()

removeInputType(string  $uniqueName, boolean  $removeColumns = false) : \Fuman_InputType

Removes input type

Parameters

Returns

addValidationGroup()

addValidationGroup(  $uniqueName, string  $expression, string  $message) 

Adds a validation group definition

Parameters

getValidationGroup()

getValidationGroup(  $uniqueName) : mixed

Parameters

Returns

getValidationGroups()

getValidationGroups() : \array[stdClass]

Gets all validation groups

Returns

getTemplateData()

getTemplateData(string|null  $orderColumn = null, boolean  $ascendingOrder = true) : array<mixed,\Fuman_Template_Data>|null

Returns prepared data for front end (design view). Internally calls getDataByRecordSetMeta and creates a record-set-meta by the given arguments.

Parameters

Returns

getTemplateDataByRecordSetMeta()

getTemplateDataByRecordSetMeta(\Fuman_Db_RecordSetMeta|null  $recordSetMeta = null, boolean  $returnOne = false) : array<mixed,\Fuman_Template_Data>|null

Returns data prepared for frontend (design view). For every record a Fuman_Template_Data object will be created.

Parameters

Returns

getRecord()

getRecord(integer  $primaryValue, string|null  $aclTableSubsetActionName = null, string|null  $recordClass = null, boolean  $ignoreSQLColumns = false) : \Fuman_Db_Record|null

Returns a {@link Fuman_Db_Record} or null by a primary Value.

Parameters

Returns

getNewRecord()

getNewRecord() : \Fuman_Db_Record

Gets a new record for this table

Returns

getRecordSet()

getRecordSet(\Fuman_Db_RecordSetMeta|null  $meta = null, string|null  $aclTableSubsetActionName = null, string|null  $recordClass = null) : \Fuman_Db_RecordSet|array<mixed,\Fuman_Db_Record>

Returns a {@link Fuman_Db_RecordSet}. The given {@link Fuman_Db_RecordSetMeta} will be extended by the subset of the {@link Fuman_Table}.

Parameters

Returns

getFirstRecord()

getFirstRecord(\Fuman_Db_RecordSetMeta|null  $meta = null, string|null  $aclTableSubsetActionName = null, string|null  $recordClass = null) : \Fuman_Db_Record

Gets first record from record set

Parameters

Returns

countRecords()

countRecords(\Fuman_Db_RecordSetMeta|null  $meta = null) : integer

Gets total record count for this table (count(*))

Parameters

Returns

getRecordIndexOf()

getRecordIndexOf(\Fuman_Db_Record  $record, \Fuman_Db_RecordSetMeta|null  $meta = null) : integer

Gets the index of an record in an ordered table

Parameters

Returns

addRelationalColumn()

addRelationalColumn(\Fuman_Column_Relation  $relationalColumn, string  $referencedColumnName) : void

Add relational column

Parameters

hasRelationalColumns()

hasRelationalColumns(string  $columnName) : array

Returns true when at minimum one relational column is added on the given column name

Parameters

Returns

getRelationalColumns()

getRelationalColumns(string  $columnName) : array<mixed,\Fuman_Column_Relation>

Returns a list with all columns which are relational to the given column name

Parameters

Returns

getAllRelationalColumns()

getAllRelationalColumns() : array<mixed,\Fuman_Column_Relation>

Return all relational columns

Returns

isSearchable()

isSearchable() : boolean

Is searchable

Returns

isJournalable()

isJournalable() : boolean

Do we have to add fuman_journal records

Returns

isHiddenInNavigation()

isHiddenInNavigation() : boolean

Is this table hidden in navigation

Returns

setHiddenInNavigation()

setHiddenInNavigation(boolean  $hidden) : void

Set hidden in navigation for table

Parameters

getInlineJavaScriptClass()

getInlineJavaScriptClass() : null

Gets the inline javascript class

Returns

getTemplateUsages()

getTemplateUsages() : array<mixed,\Fuman_Template_InputTypeUsage>

Gets usage for templating

Returns

getMeta()

getMeta(\Fuman_Db_Record  $pageRecord, string  $inputTypeUniqueName) : null|string

Gets meta data

Parameters

Returns

_initInputTypes()

_initInputTypes() 

Initialises the input types (called by default in init)

_fireRecordTableListeners()

_fireRecordTableListeners(\Fuman_Db_Record  $record, boolean  $deleted, null|string  $primaryKey = null) : void

Fires table record listeners

Parameters

_setPreparedRecordSetMetaOrder()

_setPreparedRecordSetMetaOrder(\Fuman_Db_RecordSetMeta  $meta) 

Parameters

_prepareDbRecordSetMeta()

_prepareDbRecordSetMeta(\Fuman_Db_RecordSetMeta|null  $meta = null) : \Fuman_Db_RecordSetMeta

Prepares record set meta for this table (adds subset)

Parameters

Returns