TPS
/
ORIENT
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document list widget column value events 

Documents `backend.list.overrideColumnValue` and adds and documents `backend.list.overrideColumnValueRaw`. See https://github.com/octobercms/october/issues/3180 for why this is necessary.
This commit is contained in:
Luke Towers 2017-10-18 10:57:17 -06:00 committed by GitHub
parent c7dcd386d1
commit ac2e5937f0
1 changed files with 39 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
modules/backend/widgets/Lists.php
View File

@ -846,6 +846,28 @@ class Lists extends WidgetBase
}
}
/**
* @event backend.list.overrideColumnValueRaw
* Overrides the raw column value in a list widget.
*
* If a value is returned from this event, it will be used as the raw value for the provided column.
* `$value` is passed by reference so modifying the variable in place is also supported. Example usage:
*
* Event::listen('backend.list.overrideColumnValueRaw', function($record, $column, &$value) {
* $value .= '-modified';
* });
*
* Or
*
* $listWidget->bindEvent('list.overrideColumnValueRaw', function ($record, $column, $value) {
* return 'No values for you!';
* });
*
*/
if ($response = $this->fireSystemEvent('backend.list.overrideColumnValueRaw', [$record, $column, &$value])) {
$value = $response;
}
return $value;
}
@ -871,8 +893,23 @@ class Lists extends WidgetBase
$value = $column->defaults;
}
/*
* Extensibility
/**
* @event backend.list.overrideColumnValue
* Overrides the column value in a list widget.
*
* If a value is returned from this event, it will be used as the value for the provided column.
* `$value` is passed by reference so modifying the variable in place is also supported. Example usage:
*
* Event::listen('backend.list.overrideColumnValue', function($record, $column, &$value) {
* $value .= '-modified';
* });
*
* Or
*
* $listWidget->bindEvent('list.overrideColumnValue', function ($record, $column, $value) {
* return 'No values for you!';
* });
*
*/
if ($response = $this->fireSystemEvent('backend.list.overrideColumnValue', [$record, $column, &$value])) {
$value = $response;