lucaspalomodevelop/core
1
0
Fork 0
mirror of https://github.com/lucaspalomodevelop/core.git synced 2026-03-19 19:15:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

mvc: improve searchRecordsetBase() to support the following features:

Browse Source 
* update the recordset passed in $filter_funct, similar to what the model search supports
* optional $search_clauses to overwrite post `searchPhrase` in cases we want to filter these from the controller.
This commit is contained in:
Ad Schellevis 2024-06-07 19:22:00 +02:00
parent a404e9c5a2
commit ff0e772b5b
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/opnsense/mvc/app/controllers/OPNsense/Base/ApiControllerBase.php
View File

@ -47,6 +47,7 @@ class ApiControllerBase extends ControllerRoot
* @param string|null $defaultSort default sort field name
* @param null|function $filter_funct additional filter callable
* @param int $sort_flags sorting behavior
* @param array|null $search_clauses optional overwrite to pass clauses to search instead of using searchPhrase
* @return array
*/
protected function searchRecordsetBase(
@ -54,7 +55,8 @@ class ApiControllerBase extends ControllerRoot
$fields = null,
$defaultSort = null,
$filter_funct = null,
$sort_flags = SORT_NATURAL | SORT_FLAG_CASE
$sort_flags = SORT_NATURAL | SORT_FLAG_CASE,
$search_clauses = null
) {
$records = is_array($records) ? $records : []; // safeguard input, we are only able to search arrays.
$itemsPerPage = intval($this->request->getPost('rowCount', 'int', 9999));
@ -62,7 +64,11 @@ class ApiControllerBase extends ControllerRoot
$currentPage = intval($this->request->getPost('current', 'int', 1));
$offset = ($currentPage - 1) * $itemsPerPage;
$entry_keys = array_keys($records);
$searchPhrase = (string)$this->request->getPost('searchPhrase', null, '');
if (!is_array($search_clauses)) {
/* default behavior, extract clauses to search from post */
$searchPhrase = (string)$this->request->getPost('searchPhrase', null, '');
$search_clauses = preg_split('/\s+/', $searchPhrase);
}
$sortOrder = SORT_ASC;
$sortKey = $defaultSort;
@ -86,8 +92,8 @@ class ApiControllerBase extends ControllerRoot
array_multisort($keys, $sortOrder, $sort_flags, $records);
}
$search_clauses = preg_split('/\s+/', $searchPhrase);
$entry_keys = array_filter($entry_keys, function ($key) use ($search_clauses, $filter_funct, $fields, $records) {
$entry_keys = array_filter($entry_keys, function ($key) use ($search_clauses, $filter_funct, $fields, &$records) {
if (is_callable($filter_funct) && !$filter_funct($records[$key])) {
// not applicable according to $filter_funct()
return false;