TableControl
extends Control
in package
Control for table view and actions
Tags
Table of Contents
Properties
- $dbRows : int<1, max>
- $jTable : string
- $maxPages : int
- $perPage : int<0, max>
- $primary : Form
- $sort : array<string, int>
- $subRows : int
- $actionList : array<string, array<string, mixed>>
- $actions : array<string, string>
- $columnOrder : array<string|int, Input>
- $db : SQL
- $fileApi : FileApi
- $filters : Filters|null
- $highlight : int|null
- $list : array<string|int, int>
- $multiple : bool
- $nav : AdminNavigation
- $sync : Synchronize|null
- $tabFiltered : int
- $tabOrder : array<string, string>
- $tabOrderDef : array<string|int, Input, WAY: string}>
- $tabPage : int
- $tabShow : array<int, bool>
- $tabTotal : int
Methods
- __construct() : mixed
- addAction() : void
- Form specific
- addTab() : void
- Form specific
- getCounts() : array<string, int>|int
- getCss() : array<string, mixed>
- Gets css for controller, form and plugins
- getErrors() : array<string|int, string>
- getFormById() : Form|null
- getForms() : array<string|int, Form>
- Returns list of all forms
- getList() : array<string|int, int>
- getPagination() : string
- Pagination in records
- getScript() : array<string, mixed>
- Gets javascript for current controller
- getTabColumns() : array<string|int, string>
- load() : string|null
- render() : void
- renderExport() : void
- Export data to a downloadable file
- setActions() : void
- setOrder() : void
- Table specific
- setOrderInputs() : void
- Sets the default sorting of rows in the table
- setPerPage() : void
- setPrimary() : void
- Set primary form
- setTableColumns() : void
- Sets the default order of displayed columns
- setUp() : void
- colRewrite() : string
- Insert prefix to column name
- colRewriteQuotes() : string
- createFormList() : array<string|int, Form>
- Creates list of all forms
- getAssetScript() : array<string, mixed>
- Get list of all javascript files required by used forms
- getColOrdering() : string
- getColumnList() : array<string|int, Input>
- getExportColumn() : array{ROWS: int, VAL: string}|string|null
- getRowActions() : string
- getRowClass() : array<string, string>
- isTableJoined() : bool
- loadData() : bool
- loadOrder() : void
- renderColumn() : void
- renderMultipleAction() : void
- renderRow() : void
- renderTableBody() : void
- tableReplace() : string
- updateInjections() : void
- Carry out dependency injections in form and inputs
Properties
$dbRows
public
static int<1, max>
$dbRows
= 200
$jTable
public
string
$jTable
= "jTable"
$maxPages
public
static int
$maxPages
= 20
$perPage
public
static int<0, max>
$perPage
= 50
$primary
public
Form
$primary
base form
$sort
public
static array<string, int>
$sort
= ['desc' => 1, 'asc' => 1]
$subRows
public
static int
$subRows
= 10
$actionList
protected
array<string, array<string, mixed>>
$actionList
= []
$actions
protected
array<string, string>
$actions
= []
$columnOrder
protected
array<string|int, Input>
$columnOrder
= []
$db
protected
SQL
$db
$fileApi
protected
FileApi
$fileApi
$filters
protected
Filters|null
$filters
$highlight
protected
int|null
$highlight
= null
$list
protected
array<string|int, int>
$list
= []
$multiple
protected
bool
$multiple
= false
$nav
protected
AdminNavigation
$nav
$sync
protected
Synchronize|null
$sync
$tabFiltered
protected
int
$tabFiltered
= 0
$tabOrder
protected
array<string, string>
$tabOrder
= []
$tabOrderDef
protected
array<string|int, Input, WAY: string}>
$tabOrderDef
= []
$tabPage
protected
int
$tabPage
= 1
$tabShow
protected
array<int, bool>
$tabShow
= []
$tabTotal
protected
int
$tabTotal
= 0
Methods
__construct()
public
__construct(SQL $db, AdminNavigation $nav, FileApi $fileApi, UserSession $user[, Synchronize|null $sync = null ][, Filters|null $filters = null ]) : mixed
Parameters
- $db : SQL
-
database connection
- $nav : AdminNavigation
- $fileApi : FileApi
- $user : UserSession
- $sync : Synchronize|null = null
- $filters : Filters|null = null
addAction()
Form specific
public
addAction(mixed $inputs, mixed $targets[, mixed|null $else = null ][, bool $begin = true ]) : void
Parameters
- $inputs : mixed
- $targets : mixed
- $else : mixed|null = null
- $begin : bool = true
addTab()
Form specific
public
addTab(string $name, array<string|int, Form>|Form $forms) : void
Parameters
getCounts()
public
getCounts() : array<string, int>|int
Return values
array<string, int>|intgetCss()
Gets css for controller, form and plugins
public
getCss() : array<string, mixed>
Return values
array<string, mixed>getErrors()
public
getErrors() : array<string|int, string>
Return values
array<string|int, string>getFormById()
public
getFormById(int $id) : Form|null
Parameters
- $id : int
Return values
Form|nullgetForms()
Returns list of all forms
public
getForms() : array<string|int, Form>
Return values
array<string|int, Form>getList()
public
getList() : array<string|int, int>
Return values
array<string|int, int>getPagination()
Pagination in records
public
getPagination(string $pageUrl, string $para) : string
Parameters
- $pageUrl : string
- $para : string
Return values
stringgetScript()
Gets javascript for current controller
public
getScript([string|null $jParent = null ]) : array<string, mixed>
Parameters
- $jParent : string|null = null
Return values
array<string, mixed>getTabColumns()
public
getTabColumns(string $table) : array<string|int, string>
Parameters
- $table : string
Return values
array<string|int, string>load()
public
load() : string|null
Tags
Return values
string|nullrender()
public
render() : void
renderExport()
Export data to a downloadable file
public
renderExport(string $name, string $format) : void
Parameters
- $name : string
- $format : string
Tags
setActions()
public
setActions(array<string, array<string, mixed>> $actions) : void
Parameters
- $actions : array<string, array<string, mixed>>
setOrder()
Table specific
public
setOrder(array<string|int, Input>|Input $inputs, array<string|int, string>|string $directions) : void
Parameters
Tags
setOrderInputs()
Sets the default sorting of rows in the table
public
setOrderInputs(array<string|int, Input, WAY: string}> $orders) : void
Parameters
- $orders : array<string|int, Input, WAY: string}>
setPerPage()
public
setPerPage(int<0, max> $num) : void
Parameters
- $num : int<0, max>
setPrimary()
Set primary form
public
setPrimary(Form $primary) : void
Parameters
- $primary : Form
setTableColumns()
Sets the default order of displayed columns
public
setTableColumns(array<string|int, Input> $columns) : void
Parameters
- $columns : array<string|int, Input>
setUp()
public
setUp([bool|null $foreign = null ][, bool $edit = true ]) : void
Parameters
- $foreign : bool|null = null
- $edit : bool = true
colRewrite()
Insert prefix to column name
protected
colRewrite(string $from, string $pref, string $where) : string
Parameters
- $from : string
- $pref : string
- $where : string
Return values
stringcolRewriteQuotes()
protected
colRewriteQuotes(string $quote, array<string|int, string> $esc, string $from, string $pref, string $where) : string
Parameters
- $quote : string
- $esc : array<string|int, string>
- $from : string
- $pref : string
- $where : string
Return values
stringcreateFormList()
Creates list of all forms
protected
createFormList(Form $form) : array<string|int, Form>
Parameters
- $form : Form
Return values
array<string|int, Form>getAssetScript()
Get list of all javascript files required by used forms
protected
getAssetScript(bool $edit) : array<string, mixed>
Parameters
- $edit : bool
Return values
array<string, mixed>getColOrdering()
protected
getColOrdering(string $column) : string
Parameters
- $column : string
Return values
stringgetColumnList()
protected
getColumnList() : array<string|int, Input>
Return values
array<string|int, Input>getExportColumn()
protected
getExportColumn(int $i, array<string|int, array<string|int, int>|int> $maxes, array<string|int, mixed> $tabs, string $col) : array{ROWS: int, VAL: string}|string|null
Parameters
- $i : int
- $maxes : array<string|int, array<string|int, int>|int>
- $tabs : array<string|int, mixed>
- $col : string
Return values
array{ROWS: int, VAL: string}|string|nullgetRowActions()
protected
getRowActions(int $id) : string
Parameters
- $id : int
Return values
stringgetRowClass()
protected
getRowClass(int $id) : array<string, string>
Parameters
- $id : int
Return values
array<string, string>isTableJoined()
protected
isTableJoined(array<int, array<string, mixed>> $tables, array<string, mixed> $tab) : bool
Parameters
- $tables : array<int, array<string, mixed>>
- $tab : array<string, mixed>
Return values
boolloadData()
protected
loadData(array<string|int, string>|array<string|int, int> $keys) : bool
Parameters
- $keys : array<string|int, string>|array<string|int, int>
Return values
boolloadOrder()
protected
loadOrder() : void
renderColumn()
protected
renderColumn(object $data[, array<string|int, mixed>|null $cols = null ]) : void
Parameters
- $data : object
- $cols : array<string|int, mixed>|null = null
renderMultipleAction()
protected
renderMultipleAction() : void
renderRow()
protected
renderRow(int $num, array<string|int, mixed> $tab[, array<string|int, mixed>|null $cols = null ]) : void
Parameters
- $num : int
- $tab : array<string|int, mixed>
- $cols : array<string|int, mixed>|null = null
renderTableBody()
protected
renderTableBody(bool $multiple) : void
Parameters
- $multiple : bool
tableReplace()
protected
tableReplace(string $string[, mixed $href = true ]) : string
Parameters
- $string : string
- $href : mixed = true
Return values
stringupdateInjections()
Carry out dependency injections in form and inputs
protected
updateInjections(Form $form) : void
Parameters
- $form : Form