Purpose

Set index page table properties, like table entries, color, ...

Context

Controller Context – get_index_label()

Example

    // link title in index view
    public function get_index_label()
    {
        return ['index' => [$this->name, $this->ds_rate_max.' MBit/s', $this->us_rate_max.' MBit/s'],
                'index_header' => ['Name', 'DS Rate', 'US Rate'],
                'header' => $this->name];
    }

Return

return either a array with following fields or (for historical reasons) return a string with index/header description:

* @param  - tablename of model
* @param index_header - array like [$table.'.column1' , $table.'.column2', ..., 'foreigntable1.column1', 'foreigntable2.column1', ..., 'customcolumn']
* order in index_header is important and datatables will have the column order given here
* @param bsclass - defines a Bootstrap class for colering the Rows
* @param header - defines whats written in Breadcrumbs Header at Edit and Create Pages
* @param edit - array like [$table.'.column1' => 'customfunction', 'foreigntable.column' => 'customfunction', 'customcolumn' => 'customfunction']
* customfunction will be called for every element in table.column, foreigntable.column or customcolumn
* CAREFUL customcolumn will not be sortable or searchable - to use them anyways use the disable_sortsearch key
* @param eager_loading array like [foreigntable1, foreigntable2, ...] - eager load foreign tables
* @param order_by array like ['0' => 'asc'] - order table by id in ascending order, ['1' => 'desc'] - order table after first column in descending order
* @param disable_sortsearch array like ['customcolumn' => 'false'] disables sorting & searching for the chosen column (e.g. when it is impossible) => prevent errors

Tree View

Requirements

parent_id in table

index_tree_view = true in Controller of the MVC

defined parent() and childen() function in model

view_index_label function

Optional

set icon type via $model->get_icon_type()

make entries undeletable via Model::undeletables()