TPS/birzha
TPS
/
birzha
5
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improve internal docs for DataTable callback handler 

- Changes parameters to match their intended data.
- Updates docblock
- Minor code cleanup

Refs: https://github.com/octobercms/october/issues/4664#issuecomment-539028664
This commit is contained in:
Ben Thomson 2019-10-07 22:19:13 +08:00
parent 6099312c0d
commit 970cc4550c
No known key found for this signature in database
GPG Key ID: B2BAFACC5ED68F87
1 changed files with 21 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
modules/backend/formwidgets/DataTable.php
View File

@ -165,25 +165,35 @@ class DataTable extends FormWidgetBase
}
/**
* Dropdown/autocomplete option callback handler
*
* Looks at the model for getXXXDataTableOptions or getDataTableOptions methods
* to obtain values for autocomplete field types.
* @param string $field Table field name
* @param string $data Data for the entire table
* @return array
* to obtain values for autocomplete and dropdown column types.
*
* @param string $columnName The name of the column to pass through to the callback.
* @param array $rowData The data provided for the current row in the datatable.
* @return array The options to make available to the dropdown or autocomplete, in format ["value" => "label"]
*/
public function getDataTableOptions($field, $data)
public function getDataTableOptions($columnName, $rowData)
{
$methodName = 'get'.studly_case($this->fieldName).'DataTableOptions';
$methodName = 'get' . studly_case($this->fieldName) . 'DataTableOptions';
if (!$this->model->methodExists($methodName) && !$this->model->methodExists('getDataTableOptions')) {
throw new ApplicationException(Lang::get('backend::lang.model.missing_method', ['class' => get_class($this->model), 'method' => 'getDataTableOptions']));
throw new ApplicationException(
Lang::get(
'backend::lang.model.missing_method',
[
'class' => get_class($this->model),
'method' => 'getDataTableOptions'
]
)
);
}
if ($this->model->methodExists($methodName)) {
$result = $this->model->$methodName($field, $data);
}
else {
$result = $this->model->getDataTableOptions($this->fieldName, $field, $data);
$result = $this->model->$methodName($columnName, $rowData);
} else {
$result = $this->model->getDataTableOptions($this->fieldName, $columnName, $rowData);
}
if (!is_array($result)) {