From 83c0413815e5580956a21c520a889924bb9b2eeb Mon Sep 17 00:00:00 2001 From: cgfhtw Date: Fri, 10 Mar 2023 10:29:54 +0100 Subject: [PATCH] code quality --- application/controllers/Test.php | 1 - application/controllers/dashboard/Api.php | 116 +++++++++--------- application/controllers/dashboard/Config.php | 48 +++----- .../controllers/dashboard/Dashboard.php | 9 +- .../controllers/dashboard/DashboardDemo.php | 1 - application/controllers/dashboard/Widget.php | 13 +- .../libraries/dashboard/DashboardLib.php | 53 ++++---- application/models/content/News_model.php | 27 ++-- .../dashboard/Dashboard_Preset_model.php | 2 +- .../dashboard/Dashboard_Widget_model.php | 1 - application/models/dashboard/Widget_model.php | 1 - .../views/dashboard/dashboard_demo.php | 3 +- application/views/test/Admin.php | 3 +- application/views/test/Test.php | 3 +- 14 files changed, 135 insertions(+), 146 deletions(-) diff --git a/application/controllers/Test.php b/application/controllers/Test.php index 497f12f85..bbb759606 100644 --- a/application/controllers/Test.php +++ b/application/controllers/Test.php @@ -59,5 +59,4 @@ class Test extends Auth_Controller if (!$this->_uid) show_error('User authentification failed'); } - } diff --git a/application/controllers/dashboard/Api.php b/application/controllers/dashboard/Api.php index c6ac21463..3473afe61 100644 --- a/application/controllers/dashboard/Api.php +++ b/application/controllers/dashboard/Api.php @@ -3,76 +3,74 @@ defined('BASEPATH') || exit('No direct script access allowed'); class Api extends Auth_Controller { - public function __construct() - { - parent::__construct( - array( - 'index' => 'dashboard/admin:rw', - 'getNews' => 'dashboard/admin:rw', - 'getAmpeln' => 'dashboard/admin:rw', - ) - ); + public function __construct() + { + parent::__construct( + array( + 'index' => 'dashboard/admin:rw', + 'getNews' => 'dashboard/admin:rw', + 'getAmpeln' => 'dashboard/admin:rw', + ) + ); - $this->load->library('AuthLib', null, 'AuthLib'); + $this->load->library('AuthLib', null, 'AuthLib'); - $this->_setAuthUID(); - } + $this->_setAuthUID(); + } - public function index() - { - echo 'Dashboard API Controller'; - } + public function index() + { + echo 'Dashboard API Controller'; + } - /** - * Get News. - */ - public function getNews() - { - $limit = $this->input->get('limit'); + /** + * Get News. + */ + public function getNews() + { + $limit = $this->input->get('limit'); - $this->load->model('content/News_model', 'NewsModel'); + $this->load->model('content/News_model', 'NewsModel'); - $result = $this->NewsModel->getAll($limit); + $result = $this->NewsModel->getAll($limit); - if(hasData($result)) - { - - $this->outputJson(getData($result), REST_Controller::HTTP_OK); - } - else - { - $this->terminateWithJsonError('fehler entdeckt'); - } - } + if (hasData($result)) + { + $this->outputJson(getData($result), REST_Controller::HTTP_OK); + } + else + { + $this->terminateWithJsonError('fehler entdeckt'); + } + } - /** - * Get Ampeln. - */ - public function getAmpeln(){ + /** + * Get Ampeln. + */ + public function getAmpeln() + { - $this->load->model('content/Ampel_model', 'AmpelModel'); - $result = $this->AmpelModel->getByUser($this->_uid); + $this->load->model('content/Ampel_model', 'AmpelModel'); + $result = $this->AmpelModel->getByUser($this->_uid); - if(hasData($result)) - { + if (hasData($result)) + { + $this->outputJson(getData($result), REST_Controller::HTTP_OK); + } + else + { + $this->terminateWithJsonError('fehler entdeckt'); + } + } - $this->outputJson(getData($result), REST_Controller::HTTP_OK); - } - else - { - $this->terminateWithJsonError('fehler entdeckt'); - } + /** + * Retrieve the UID of the logged user and checks if it is valid + */ + private function _setAuthUID() + { + $this->_uid = getAuthUID(); - } - - /** - * Retrieve the UID of the logged user and checks if it is valid - */ - private function _setAuthUID() - { - $this->_uid = getAuthUID(); - - if (!$this->_uid) show_error('User authentification failed'); - } + if (!$this->_uid) show_error('User authentification failed'); + } } diff --git a/application/controllers/dashboard/Config.php b/application/controllers/dashboard/Config.php index b9c4c6c31..444597ce5 100644 --- a/application/controllers/dashboard/Config.php +++ b/application/controllers/dashboard/Config.php @@ -29,7 +29,7 @@ class Config extends Auth_Controller $this->load->model('ressource/Funktion_model', 'FunktionModel'); } - public function index() + public function index() { $dashboard_kurzbz = $this->input->get('db'); $uid = $this->AuthLib->getAuthObj()->username; @@ -46,7 +46,7 @@ class Config extends Auth_Controller $this->outputJsonSuccess($mergedconfig); } - public function genWidgetId() + public function genWidgetId() { $dashboard_kurzbz = $this->input->get('db'); $widgetid = $this->DashboardLib->generateWidgetId($dashboard_kurzbz); @@ -55,23 +55,22 @@ class Config extends Auth_Controller )); } - public function addWidgetsToPreset() + public function addWidgetsToPreset() { $input = json_decode($this->input->raw_input_stream); $dashboard_kurzbz = $input->db; $funktion_kurzbz = $input->funktion_kurzbz; - $preset = $this->DashboardLib->getPresetOrCreateEmptyPreset($dashboard_kurzbz, $funktion_kurzbz); + $preset = $this->DashboardLib->getPresetOrCreateEmptyPreset($dashboard_kurzbz, $funktion_kurzbz); $preset_decoded = json_decode($preset->preset, true); - $this->DashboardLib->addWidgetsToWidgets($preset_decoded['widgets'], - $dashboard_kurzbz, $funktion_kurzbz, $input->widgets); + $this->DashboardLib->addWidgetsToWidgets($preset_decoded['widgets'], $dashboard_kurzbz, $funktion_kurzbz, $input->widgets); $preset->preset = json_encode($preset_decoded); $result = $this->DashboardLib->insertOrUpdatePreset($preset); - if( isError($result) ) { + if (isError($result)) { http_response_code(500); $this->terminateWithJsonError('preset could not be saved'); } @@ -87,16 +86,13 @@ class Config extends Auth_Controller $widgetid = $input->widgetid; $preset = $this->DashboardLib->getPreset($dashboard_kurzbz, $funktion_kurzbz); - if( $preset === null ) { + if ($preset === null) { http_response_code(404); - $this->terminateWithJsonError('preset for dashboard ' - . $dashboard_kurzbz . ' and funktion ' . $funktion_kurzbz - . ' not found.'); + $this->terminateWithJsonError('preset for dashboard ' . $dashboard_kurzbz . ' and funktion ' . $funktion_kurzbz . ' not found.'); } $preset_decoded = json_decode($preset->preset, true); - if (!$this->DashboardLib->removeWidgetFromWidgets($preset_decoded['widgets'], - $funktion_kurzbz, $widgetid)) + if (!$this->DashboardLib->removeWidgetFromWidgets($preset_decoded['widgets'], $funktion_kurzbz, $widgetid)) { http_response_code(404); $this->terminateWithJsonError('widgetid ' . $widgetid . ' not found'); @@ -104,32 +100,31 @@ class Config extends Auth_Controller $preset->preset = json_encode($preset_decoded); $result = $this->DashboardLib->insertOrUpdatePreset($preset); - if( isError($result) ) + if (isError($result)) { http_response_code(500); - $this->terminateWithJsonError('failed to remove widget'); + $this->terminateWithJsonError('failed to remove widget'); } $this->outputJsonSuccess(array('msg' => 'preset successfully updated.')); } - public function addWidgetsToUserOverride() + public function addWidgetsToUserOverride() { $input = json_decode($this->input->raw_input_stream); $dashboard_kurzbz = $input->db; $funktion_kurzbz = $input->funktion_kurzbz; $uid = $this->AuthLib->getAuthObj()->username; - $override = $this->DashboardLib->getOverrideOrCreateEmptyOverride($dashboard_kurzbz, $uid); + $override = $this->DashboardLib->getOverrideOrCreateEmptyOverride($dashboard_kurzbz, $uid); $override_decoded = json_decode($override->override, true); - $this->DashboardLib->addWidgetsToWidgets($override_decoded['widgets'], - $dashboard_kurzbz, $funktion_kurzbz, $input->widgets); + $this->DashboardLib->addWidgetsToWidgets($override_decoded['widgets'], $dashboard_kurzbz, $funktion_kurzbz, $input->widgets); $override->override = json_encode($override_decoded); $result = $this->DashboardLib->insertOrUpdateOverride($override); - if( isError($result) ) { + if (isError($result)) { http_response_code(500); $this->terminateWithJsonError('override could not be saved'); } @@ -146,16 +141,14 @@ class Config extends Auth_Controller $widgetid = $input->widgetid; $override = $this->DashboardLib->getOverride($dashboard_kurzbz, $uid); - if( empty($override) ) { + if (empty($override)) { http_response_code(404); - $this->terminateWithJsonError('userconfig for dashboard ' - . $dashboard_kurzbz . ' not found.'); + $this->terminateWithJsonError('userconfig for dashboard ' . $dashboard_kurzbz . ' not found.'); } $override_decoded = json_decode($override->override, true); - if( !$this->DashboardLib->removeWidgetFromWidgets($override_decoded['widgets'], - $funktion_kurzbz, $widgetid) ) + if (!$this->DashboardLib->removeWidgetFromWidgets($override_decoded['widgets'], $funktion_kurzbz, $widgetid)) { http_response_code(404); $this->terminateWithJsonError('widgetid ' . $widgetid . ' not found'); @@ -163,10 +156,10 @@ class Config extends Auth_Controller $override->override = json_encode($override_decoded); $result = $this->DashboardLib->insertOrUpdateOverride($override, $uid); - if( isError($result) ) + if (isError($result)) { http_response_code(500); - $this->terminateWithJsonError('failed to remove widget'); + $this->terminateWithJsonError('failed to remove widget'); } $this->outputJsonSuccess(array('msg' => 'override successfully updated.')); } @@ -220,5 +213,4 @@ class Config extends Auth_Controller return $this->outputJsonSuccess($result); } - } diff --git a/application/controllers/dashboard/Dashboard.php b/application/controllers/dashboard/Dashboard.php index 8cf37d579..e827a0c7c 100644 --- a/application/controllers/dashboard/Dashboard.php +++ b/application/controllers/dashboard/Dashboard.php @@ -22,7 +22,7 @@ class Dashboard extends Auth_Controller $this->load->model('dashboard/Dashboard_model', 'DashboardModel'); } - public function index() + public function index() { $result = $this->DashboardModel->load(); @@ -36,7 +36,7 @@ class Dashboard extends Auth_Controller return $this->outputJsonSuccess(getData($result) ?: []); } - public function Create() + public function Create() { $input = $this->getPostJSON(); @@ -52,7 +52,7 @@ class Dashboard extends Auth_Controller return $this->outputJsonSuccess(getData($result) ?: []); } - public function Update() + public function Update() { $input = $this->getPostJSON(); @@ -68,7 +68,7 @@ class Dashboard extends Auth_Controller return $this->outputJsonSuccess(getData($result) ?: []); } - public function Delete() + public function Delete() { $input = $this->getPostJSON(); @@ -83,5 +83,4 @@ class Dashboard extends Auth_Controller return $this->outputJsonSuccess(getData($result) ?: []); } - } diff --git a/application/controllers/dashboard/DashboardDemo.php b/application/controllers/dashboard/DashboardDemo.php index 7088c44b9..9822fafc5 100644 --- a/application/controllers/dashboard/DashboardDemo.php +++ b/application/controllers/dashboard/DashboardDemo.php @@ -47,5 +47,4 @@ class DashboardDemo extends Auth_Controller if (!$this->_uid) show_error('User authentification failed'); } - } diff --git a/application/controllers/dashboard/Widget.php b/application/controllers/dashboard/Widget.php index 07c57ea73..0da6fe8da 100644 --- a/application/controllers/dashboard/Widget.php +++ b/application/controllers/dashboard/Widget.php @@ -23,7 +23,7 @@ class Widget extends Auth_Controller $this->load->model('dashboard/Dashboard_Widget_model', 'DashboardWidgetModel'); } - public function index() + public function index() { $widget_id = $this->input->get('id'); @@ -48,7 +48,7 @@ class Widget extends Auth_Controller return $this->outputJsonSuccess(current(getData($widget))); } - public function getAll() + public function getAll() { $dashboard_id = $this->input->get('dashboard_id'); $result = $this->WidgetModel->getWithAllowedForDashboard($dashboard_id); @@ -59,7 +59,7 @@ class Widget extends Auth_Controller $this->outputJsonSuccess(getData($result) ?: []); } - public function getWidgetsForDashboard() + public function getWidgetsForDashboard() { $db = $this->input->get('db'); $result = $this->WidgetModel->getForDashboard($db); @@ -74,7 +74,8 @@ class Widget extends Auth_Controller $this->outputJsonSuccess(getData($result) ?: []); } - public function setAllowed() { + public function setAllowed() + { $input = $this->getPostJSON(); $dashboard_id = $input->dashboard_id; @@ -83,12 +84,12 @@ class Widget extends Auth_Controller if ($action == 'add') { $result = $this->DashboardWidgetModel->insert([ - 'dashboard_id' => $dashboard_id, + 'dashboard_id' => $dashboard_id, 'widget_id' => $widget_id ]); } elseif ($action == 'delete') { $result = $this->DashboardWidgetModel->delete([ - 'dashboard_id' => $dashboard_id, + 'dashboard_id' => $dashboard_id, 'widget_id' => $widget_id ]); } else { diff --git a/application/libraries/dashboard/DashboardLib.php b/application/libraries/dashboard/DashboardLib.php index 3f189fc03..b9062fdce 100644 --- a/application/libraries/dashboard/DashboardLib.php +++ b/application/libraries/dashboard/DashboardLib.php @@ -1,5 +1,8 @@ _ci =& get_instance(); @@ -24,25 +27,24 @@ class DashboardLib $this->_ci->load->model('dashboard/Dashboard_Override_model', 'DashboardOverrideModel'); } - public function generateWidgetId($dashboard_kurzbz='') + public function generateWidgetId($dashboard_kurzbz = '') { - $dashboard_kurzbz = (!empty($dashboard_kurzbz)) ? $dashboard_kurzbz - : self::DEFAULT_DASHBOARD_KURZBZ; - $widgetid_input = time() . '_' . $dashboard_kurzbz . '_' - . bin2hex(random_bytes(self::WIDGET_ID_RANDOM_BYTES)); + $dashboard_kurzbz = (!empty($dashboard_kurzbz)) ? $dashboard_kurzbz : self::DEFAULT_DASHBOARD_KURZBZ; + $widgetid_input = time() . '_' . $dashboard_kurzbz . '_' . bin2hex(random_bytes(self::WIDGET_ID_RANDOM_BYTES)); $widgetid = md5($widgetid_input); return $widgetid; } public function getDashboardByKurzbz($dashboard_kurzbz) { - $dashboard = null; $result = $this->_ci->DashboardModel->getDashboardByKurzbz($dashboard_kurzbz); - if( isSuccess($result) && ($dashboards = getData($result)) ) + + if (hasData($result)) { - $dashboard = $dashboards[0]; + return current(getData($result)) } - return $dashboard; + + return null; } public function getMergedConfig($dashboard_id, $uid) @@ -60,12 +62,13 @@ class DashboardLib $res_presets = $this->_ci->DashboardPresetModel->getPresets($dashboard_id, $uid); $defaultconfig = array(); - if( isSuccess($res_presets) && hasData($res_presets) ) + if (hasData($res_presets)) { $presets = getData($res_presets); foreach ($presets as $presetobj) { - if( null !== ($preset = json_decode($presetobj->preset, true)) ) + $preset = json_decode($presetobj->preset, true); + if (null !== $preset) { $defaultconfig = array_replace_recursive($defaultconfig, $preset); @@ -79,18 +82,18 @@ class DashboardLib public function getUserConfig($dashboard_id, $uid) { $res_userconfig = $this->_ci->DashboardOverrideModel->getOverride($dashboard_id, $uid); - $userconfig = array(); - if( isSuccess($res_userconfig) && hasData($res_userconfig) ) + if (hasData($res_userconfig)) { $data = getData($res_userconfig); - if( null !== ($decodedconfig = json_decode($data[0]->override, true)) ) + $decodedconfig = json_decode(current($data)->override, true); + if (null !== $decodedconfig) { - $userconfig = $decodedconfig; + return $decodedconfig; } } - return $userconfig; + return []; } public function getOverrideOrCreateEmptyOverride($dashboard_kurzbz, $uid) @@ -123,7 +126,7 @@ class DashboardLib $emptypreset->dashboard_id = $dashboard->dashboard_id; $emptypreset->funktion_kurzbz = $funktion_kurzbz; $section = ($funktion_kurzbz !== null) ? $funktion_kurzbz : self::SECTION_IF_FUNKTION_KURZBZ_IS_NULL; - $emptypreset->preset = '{"widgets": {"' . $funktion_kurzbz . '": {}}}'; + $emptypreset->preset = '{"widgets": {"' . $section . '": {}}}'; return $emptypreset; } @@ -131,34 +134,32 @@ class DashboardLib public function getPreset($dashboard_kurzbz, $section) { $dashboard = $this->getDashboardByKurzbz($dashboard_kurzbz); - $preset = null; $funktion_kurzbz = ($section === self::SECTION_IF_FUNKTION_KURZBZ_IS_NULL) ? null : $section; $result = $this->_ci->DashboardPresetModel ->getPresetByDashboardAndFunktion($dashboard->dashboard_id, $funktion_kurzbz); - if( isSuccess($result) && hasData($result) && ($presets = getData($result)) ) + if (hasData($result)) { - $preset = $presets[0]; + return current(getData($result)); } - return $preset; + return null; } public function getOverride($dashboard_kurzbz, $uid) { $dashboard = $this->getDashboardByKurzbz($dashboard_kurzbz); - $override = null; $result = $this->_ci->DashboardOverrideModel ->getOverride($dashboard->dashboard_id, $uid); - if( isSuccess($result) && hasData($result) && ($overrides = getData($result)) ) + if (hasData($result)) { - $override = $overrides[0]; + return current(getData($result)); } - return $override; + return null; } public function insertOrUpdatePreset($preset) diff --git a/application/models/content/News_model.php b/application/models/content/News_model.php index 472eb2e56..ce42aa2db 100644 --- a/application/models/content/News_model.php +++ b/application/models/content/News_model.php @@ -12,18 +12,17 @@ class News_model extends DB_Model $this->pk = 'news_id'; } - /** - * Get all News ordered by date. (most actual on top) - * @param null $limit Amount of news. - * @return array - */ - public function getAll($limit = null) - { - return $this->loadWhere(' - text IS NOT NULL - AND datum <= NOW() AND (datum_bis IS NULL OR datum_bis >= now()::date) - ORDER BY datum DESC - LIMIT '. $this->escape($limit) - ); - } + /** + * Get all News ordered by date. (most actual on top) + * @param null $limit Amount of news. + * @return array + */ + public function getAll($limit = null) + { + return $this->loadWhere(' + text IS NOT NULL + AND datum <= NOW() AND (datum_bis IS NULL OR datum_bis >= now()::date) + ORDER BY datum DESC + LIMIT '. $this->escape($limit)); + } } diff --git a/application/models/dashboard/Dashboard_Preset_model.php b/application/models/dashboard/Dashboard_Preset_model.php index c899195d4..ca10ce98a 100644 --- a/application/models/dashboard/Dashboard_Preset_model.php +++ b/application/models/dashboard/Dashboard_Preset_model.php @@ -60,7 +60,7 @@ EOSQL; * @param string funktion_kurzbz * @return array */ - public function getPresetByDashboardAndFunktion($dashboard_id, $funktion_kurzbz) + public function getPresetByDashboardAndFunktion($dashboard_id, $funktion_kurzbz) { return $this->loadWhere(array('dashboard_id' => $dashboard_id, 'funktion_kurzbz' => $funktion_kurzbz)); } diff --git a/application/models/dashboard/Dashboard_Widget_model.php b/application/models/dashboard/Dashboard_Widget_model.php index eb4540cd9..9e0a4c200 100644 --- a/application/models/dashboard/Dashboard_Widget_model.php +++ b/application/models/dashboard/Dashboard_Widget_model.php @@ -12,5 +12,4 @@ class Dashboard_Widget_model extends DB_Model $this->pk = ['dashboard_id', 'widget_id']; $this->hasSequence = false; } - } diff --git a/application/models/dashboard/Widget_model.php b/application/models/dashboard/Widget_model.php index 554c7dea6..b1160e28f 100644 --- a/application/models/dashboard/Widget_model.php +++ b/application/models/dashboard/Widget_model.php @@ -29,5 +29,4 @@ class Widget_model extends DB_Model return $this->loadWhere(['dashboard_kurzbz' => $db]); } - } diff --git a/application/views/dashboard/dashboard_demo.php b/application/views/dashboard/dashboard_demo.php index 3518d769a..8efc230b7 100644 --- a/application/views/dashboard/dashboard_demo.php +++ b/application/views/dashboard/dashboard_demo.php @@ -1,5 +1,6 @@ load->view('templates/FHC-Header', +$this->load->view( + 'templates/FHC-Header', array( 'title' => 'FH-Complete', 'bootstrap5' => true, diff --git a/application/views/test/Admin.php b/application/views/test/Admin.php index 837f6411b..c5fa8b64c 100644 --- a/application/views/test/Admin.php +++ b/application/views/test/Admin.php @@ -1,5 +1,6 @@ load->view('templates/FHC-Header', +$this->load->view( + 'templates/FHC-Header', array( 'title' => 'FH-Complete', 'bootstrap5' => true, diff --git a/application/views/test/Test.php b/application/views/test/Test.php index d297bf4ec..328b45fba 100644 --- a/application/views/test/Test.php +++ b/application/views/test/Test.php @@ -1,5 +1,6 @@ load->view('templates/FHC-Header', +$this->load->view( + 'templates/FHC-Header', array( 'title' => 'FH-Complete', 'bootstrap5' => true,