public function table()
{
# By default, require that the user be logged in to access the table. If you want additional
# permissions, use the lucid::$app->$security->requirePermission() function.
#lucid::$app->permission()->requireLogin();
# lucid::$app->$security->requirePermission(); # add required permissions to this array
# Set the title tag for the page. Optionally, you can also set the description or keywords meta tag
# by calling lucid::$app->$response->description() or lucid::$app->$response->keywords()
lucid::$app->response()->title(lucid::$app->i18n()->translate('branding:app_name') . ' - {{title}}');
# Render the navigation controller.
lucid::$app->factory()->view('navigation')->render('dashboard.view.admin', 'regions.view.table');
# build the data table. The parameters are as follows:
# 0) The title of the table. This text is placed inside the card header, and defaults to the name of the modelName
# 1) A name for the table. This is used to identify refresh requests for table data. This needs to be unique for each table
# 2) A model for the table. You may add any where clauses you want before passing the model as a parameter.
# 3) A url that will result in this table's code being loaded. It doesn't necessarily need to point to this view, as long
# as you're sure that this code will be run as a result of loading that url. This url is used to refresh the data in
# the table when it is sorted/paged/filtered.
# 4) The default sort column for this table. Starts at 0. If you want the table sorted by default by the 3rd column, the
# value should be 2.
# 5) The default sort direction for this table. May be either 'asc' or 'desc'
# 6) The page size for the table, defaults to 10
# 7) The current page for the table, defaults to 0 (first page)
$table = html::dataTable(lucid::$app->i18n()->translate('model:regions'), 'regions-table', $this->controller()->getList(), 'actions.php?action=regions.view.table');
# Add a default renderer for the table. This function is called when rendering every column (unless it is overridden
# at the column level), and is passed the data for the entire row. This returns the html that should be placed into
# the cell for that row/column
$table->renderer = function ($data, string $column) {
return html::anchor('#!regions.view.edit|region_id|' . $data->region_id, $data->{$column});
};
# Add the table's columns. The parameters for the constructor are:
# 0) The label for the column
# 1) The database field name that should be sorted on when the user sorts the data by this column
# 3) The width of this column, expressed as a % (ex: 25%)
# 4) boolean true/false: whether or not this column can be used to sort the table
# 5) An optional renderer function. This function works like the table rendering function
$table->add(html::dataColumn(lucid::$app->i18n()->translate('model:regions:country_id'), 'country_id', '15%', true));
$table->add(html::dataColumn(lucid::$app->i18n()->translate('model:regions:abbreviation'), 'abbreviation', '15%', true));
$table->add(html::dataColumn(lucid::$app->i18n()->translate('model:regions:name'), 'name', '15%', true));
$table->add(html::dataColumn(lucid::$app->i18n()->translate('model:regions:type'), 'type', '15%', true));
$table->add(html::dataColumn(lucid::$app->i18n()->translate('model:regions:parent'), 'parent', '15%', true));
$table->add(html::dataColumn(lucid::$app->i18n()->translate('model:regions:is_parent'), 'is_parent', '15%', true));
# Add a column specifically for deleting rows.
$table->add(html::dataColumn('', null, '10%', false, function ($data) {
return html::button(lucid::$app->i18n()->translate('button:delete'), 'danger', "if(confirm('" . lucid::$app->i18n()->translate('button:confirm_delete') . "')){ lucid.request('#!regions.controller.delete|region_id|" . $data->region_id . "');}")->size('sm')->pull('right');
}));
# Enable searching this table based on some of the fields
$table->enableSearchFilter(['country_id', 'abbreviation', 'name', 'type', 'parent']);
# Enable adding rows to the table. This simply links to the edit form, and passes the value 0 into the
# varialble $region_id on the form.
$table->enableAddNewButton('#!regions.view.edit|region_id|0', lucid::$app->i18n()->translate('button:add_new'));
# This function call is very important. It looks in $_REQUEST to see if this request is from this same table, asking
# for new data due to sorting, paging, or filtering. If it determines that this is case, only the table's body is rendered,
# and that html is sent back to the client where it is inserted in place of the existing table data. Sending back that
# response ends execution of the view.
$table->sendRefresh();
# Render out the table, and place it into the webpage.
lucid::$app->response()->replace('#main-rightcol', $table->render());
}
