WebSVN – oidplus – Diff – /trunk/plugins/viathinksoft/adminPages/010_notifications/OIDplusPageAdminNotifications.class.php

 \defined('INSIDE_OIDPLUS') or die;
 // phpcs:enable PSR1.Files.SideEffects
 class OIDplusPageAdminNotifications extends OIDplusPagePluginAdmin {
+        /**
+         * @param bool $html
+         * @return void
+         */
-        public function init($html=true) {
+        public function init(bool $html=true) {
+        }
+        /**
+         * @param string $id
+         * @param array $out
+         * @param bool $handled
+         * @return void
+         * @throws OIDplusException
+         */
-        public function gui($id, &$out, &$handled) {
+        public function gui(string $id, array &$out, bool &$handled) {
                 $parts = explode('$',$id);
                 $id = $parts[0];
                 if ($id == 'oidplus:notifications') {
                         $handled = true;
                         $notifications_by_sev = array();
                         foreach (OIDplus::getAllPlugins() as $plugin) {
                                 if ($plugin->implementsFeature('1.3.6.1.4.1.37476.2.5.2.3.8')) {
-                                        $notifications = $plugin->getNotifications($ra_email);
+                                        $notifications = $plugin->getNotifications($ra_email); /** @phpstan-ignore-line */
                                         if ($notifications) {
                                                 foreach ($notifications as $notification) {
                                                         list($severity, $htmlMessage) = $notification;
                                                         // Same severities as the log plugin (also same CSS classes)
+                                }
+                        }
+                }
+        }
+        /**
+         * @param array $json
+         * @param string|null $ra_email
+         * @param bool $nonjs
+         * @param string $req_goto
+         * @return bool
+         * @throws OIDplusException
+         */
-        public function tree(&$json, $ra_email=null, $nonjs=false, $req_goto='') {
+        public function tree(array &$json, string $ra_email=null, bool $nonjs=false, string $req_goto=''): bool {
                 if (!OIDplus::authUtils()->isAdminLoggedIn()) return false;
                 if (file_exists(__DIR__.'/img/main_icon16.png')) {
                         $tree_icon = OIDplus::webpath(__DIR__,OIDplus::PATH_RELATIVE).'img/main_icon16.png';
                 } else {
                 );
                 return true;
+        }
+        /**
+         * @param string $request
+         * @return array|false
+         */
-        public function tree_search($request) {
+        public function tree_search(string $request) {
                 return false;
+        }
+        /**
+         * @param string $id
+         * @return bool
+         */
-        public function implementsFeature($id) {
+        public function implementsFeature(string $id): bool {
                 if (strtolower($id) == '1.3.6.1.4.1.37476.2.5.2.3.8') return true; // getNotifications()
                 return false;
+        }
+        /**
-        private function webAccessWorks($dir) {
+         * Checks if the system can be accessed publicly
-                // Attention! This check does not work if OIDplus is password protected!
+         * Attention! This check does not work if OIDplus is password protected (solution would be to check via JavaScript,
-                //            The only real solution is to check via JavaScript, which is done by setup/
+         * which is done in setup/), or the URL is in the IntraNet rather than the Internet (only solution would be a
+         * remote URL check service)
+         * @param string $dir
+         * @return false|string
+         * @throws OIDplusException
+         */
+        private function webAccessWorks(string $dir) {
                 $url = OIDplus::webpath(null,OIDplus::PATH_ABSOLUTE_CANONICAL).$dir;
                 $access_worked = url_get_contents($url) !== false;
                 if ($access_worked) return $url;
                 if (!$access_worked) {
+                }
                 return false;
+        }
+        /**
+         * @param string $dir
+         * @return array
+         * @throws OIDplusException
+         */
-        private function getNotificationsCheckDirAccess($dir) {
+        private function getNotificationsCheckDirAccess(string $dir) {
                 $notifications = array();
                 if (($url = $this->webAccessWorks($dir)) !== false) {
                         // Re-use message taken from setup/includes/setup_base.js
                         $msg = _L('Attention: The following directory is world-readable: %1 ! You need to configure your web server to restrict access to this directory! (For Apache see <i>.htaccess</i>, for Microsoft IIS see <i>web.config</i>, for Nginx see <i>nginx.conf</i>).','<a target="_blank" href="'.$url.'">'.$dir.'</a>');
                         $notifications[] = array('CRIT', $msg);
+                }
                 return $notifications;
+        }
+        /**
+         * Implements interface 1.3.6.1.4.1.37476.2.5.2.3.8
+         * These are some basic "system" checks, no checks from other plugin. So we add them to our plugin instead.
+         * @param $user
+         * @return array
+         * @throws OIDplusException
+         */
         public function getNotifications($user=null): array {
-                // Interface 1.3.6.1.4.1.37476.2.5.2.3.8
-                // These are some basic "system" checks, no checks from other plugin. So we add them to our plugin instead.
                 $notifications = array();
                 if ((!$user || ($user == 'admin')) && OIDplus::authUtils()->isAdminLoggedIn()) {
                         // Check if critical directories are world-readable
                         if ($this->webAccessWorks('index.php') === false) {
                                 $notifications[] = array('INFO', _L("The system can't check if critical directories (%1) are readable via web-browser. Please verify it manually.", 'userdata, res, dev, includes, setup/includes'));

Subversion Repositories oidplus

oidplus/trunk/plugins/viathinksoft/adminPages/010_notifications/OIDplusPageAdminNotifications.class.php – Rev 1086 → 1116