Class ListConfiguration

TableAccess

TableLists

ListConfiguration

Copyright: 2004-2016 The Admidio Team
License: GNU General Public License v2.0 only **********************************************************************************************
Class:

ListConfiguration This class creates a list configuration object. With this object it's possible to manage the configuration in the database. You can easily create new lists, add new columns or remove columns.

Beside the methods of the parent class there are the following additional methods:

readColumns() - Daten der zugehoerigen Spalten einlesen und in Objekten speichern addColumn($number, $field, $sort = "", $condition = "") - fuegt eine neue Spalte dem Spaltenarray hinzu deleteColumn($number, $all = false) - entfernt die entsprechende Spalte aus der Konfiguration countColumns() - Anzahl der Spalten der Liste zurueckgeben getSQL($roleIds, $memberStatus = 0) - gibt das passende SQL-Statement zu der Liste zurueck

Located at listconfiguration.php

Methods summary

`public`	# `__construct( Database & $database, integer $lstId = 0 )` Constructor that will create an object to handle the configuration of lists. Constructor that will create an object to handle the configuration of lists. Parameters `$database` Object of the class Database. This should be the default global object @b $gDb. `$lstId` The id of the recordset that should be loaded. If id isn't set than an empty object of the table is created. Overrides `TableLists::__construct`
`public boolean`	# `addColumn( integer $number, integer\|string $field, string $sort = '', string $filter = '' )` Add new column to column array Add new column to column array Parameters `$number` `$field` `$sort` `$filter` Returns boolean
`public`	# `clear( )` Initializes all class parameters and deletes all read data. Also the database structure of the associated table will be read and stored in the arrays @b dbColumns and @b columnsInfos Initializes all class parameters and deletes all read data. Also the database structure of the associated table will be read and stored in the arrays @b dbColumns and @b columnsInfos Overrides `TableAccess::clear`
`public integer`	# `countColumns( )` Return count of columns Return count of columns Returns integer
`public boolean`	# `deleteColumn( integer $number, boolean $all = false )` Delete pointed columns out of configuration Delete pointed columns out of configuration Parameters `$number` `$all` Define all columns to be deleted Returns boolean
`public TableAccess\|null`	# `getColumnObject( integer $number )` Returns the column object with the corresponding number. If that column doesn't exists the method try to repair the column list. If that won't help then @b null will be returned. Returns the column object with the corresponding number. If that column doesn't exists the method try to repair the column list. If that won't help then @b null will be returned. Parameters `$number` The internal number of the column. This will be the position of the column in the list. Returns `TableAccess`\|null Returns a TableAccess object of the database table @b adm_list_columns.
`public string`	# `getSQL( array $roleIds, integer $memberStatus = 0, string $startDate = null, string $endDate = null )` prepare SQL to list configuration prepare SQL to list configuration Parameters `$roleIds` Array with all roles, which members are shown `$memberStatus` 0 - Only active members of a role 1 - Only former members 2 - Active and former members of a role `$startDate` `$endDate` Returns string
`public`	# `readColumns( )` Read data of responsible columns and store in object Read data of responsible columns and store in object
`public`	# `repair( )` The method will clear all column data of this object and restore all columns from the database. Then the column number will be renewed for all columns. This is in some cases a necessary fix if a column number was lost. The method will clear all column data of this object and restore all columns from the database. Then the column number will be renewed for all columns. This is in some cases a necessary fix if a column number was lost.
`public boolean`	# `save( boolean $updateFingerPrint = true )` Parameters `$updateFingerPrint` Returns boolean Overrides `TableLists::save`

Methods inherited from TableLists

delete()

Methods inherited from TableAccess

__sleep(), connectAdditionalTable(), countAllRecords(), getValue(), hasColumnsValueChanged(), isNewRecord(), readData(), readDataByColumns(), readDataById(), setArray(), setDatabase(), setValue()

Properties summary

`protected array`	`$columns`	# `array()`

Properties inherited from TableAccess

$additionalTables, $columnPrefix, $columnsInfos, $columnsValueChanged, $db, $dbColumns, $keyColumnName, $new_record, $tableName

Packages

Classes

Exceptions

Functions

Class ListConfiguration

Methods summary

Parameters

Overrides

Parameters

Returns

Overrides

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Overrides

Methods inherited from TableLists

Methods inherited from TableAccess

Properties summary

Properties inherited from TableAccess