WebSVN – oidplus – Diff – /trunk/plugins/viathinksoft/publicPages/500_resources/OIDplusPagePublicResources.class.php

 \defined('INSIDE_OIDPLUS') or die;
 // phpcs:enable PSR1.Files.SideEffects
 class OIDplusPagePublicResources extends OIDplusPagePluginPublic {
+        /**
+         * @return array|mixed|string|string[]
+         */
         private function getMainTitle() {
                 return _L('Documents and Resources');
+        }
+        /**
+         * @param bool $html
+         * @return void
+         * @throws OIDplusException
+         */
-        public function init($html=true) {
+        public function init(bool $html=true) {
                 OIDplus::config()->prepareConfigKey('resource_plugin_autoopen_level', 'Resource plugin: How many levels should be open in the treeview when OIDplus is loaded?', '1', OIDplusConfig::PROTECTION_EDITABLE, function($value) {
                         if (!is_numeric($value) || ($value < 0)) {
                                 throw new OIDplusException(_L('Please enter a valid value.'));
+                        }
                 });
                                 throw new OIDplusException(_L('Please enter a valid value (0=no, 1=yes).'));
+                        }
                 });
+        }
+        /**
+         * @param $file
+         * @return string
+         * @throws OIDplusConfigInitializationException
+         * @throws OIDplusException
+         */
         private static function getDocumentContent($file) {
                 $file = self::realname($file);
                 $file2 = preg_replace('/\.([^.]+)$/', '$'.OIDplus::getCurrentLang().'.\1', $file);
                 if (file_exists($file2)) $file = $file2;
                 $cont .= stripHtmlComments($html);
                 return $cont;
+        }
+        /**
+         * @param $file
+         * @return array|mixed|string
+         * @throws OIDplusConfigInitializationException
+         * @throws OIDplusException
+         */
         private static function getDocumentTitle($file) {
                 $file = self::realname($file);
                 $file2 = preg_replace('/\.([^.]+)$/', '$'.OIDplus::getCurrentLang().'.\1', $file);
                 if (file_exists($file2)) $file = $file2;
                 if (preg_match('@<h5>(.+)</h5>@ismU', $cont, $m)) return $m[1];
                 if (preg_match('@<h6>(.+)</h6>@ismU', $cont, $m)) return $m[1];
                 return pathinfo($file, PATHINFO_FILENAME); // filename without extension
+        }
+        /**
+         * @param $source
+         * @return bool
+         * @throws OIDplusException
+         */
         protected static function mayAccessResource($source) {
                 if (OIDplus::authUtils()->isAdminLoggedIn()) return true;
                 $candidates = array(
                         OIDplus::localpath().'userdata/resources/security.ini',
+                        }
+                }
                 return true;
+        }
+        /**
+         * @param $reldir
+         * @param $onlydir
+         * @return array
+         * @throws OIDplusException
+         */
         private static function myglob($reldir, $onlydir=false) {
                 $out = array();
                 $root = OIDplus::localpath().'userdata/resources/';
                 $res = $onlydir ? @glob($root.ltrim($reldir,'/'), GLOB_ONLYDIR) : @glob($root.ltrim($reldir,'/'));
                 return array_filter($out, function($v, $k) {
                         return self::mayAccessResource($v);
                 }, ARRAY_FILTER_USE_BOTH);
+        }
+        /**
+         * @param $rel
+         * @return string|null
+         */
         private static function realname($rel) {
                 $candidate1 = OIDplus::localpath().'userdata/resources/'.$rel;
                 $candidate2 = OIDplus::localpath().'res/'.$rel;
                 if (file_exists($candidate1) || is_dir($candidate1)) return $candidate1;
                 if (file_exists($candidate2) || is_dir($candidate2)) return $candidate2;
                 return null;
+        }
+        /**
+         * @param $source
+         * @param $target
+         * @return bool
+         */
         protected static function checkRedirect($source, &$target): bool {
                 $candidates = array(
                         OIDplus::localpath().'userdata/resources/redirect.ini',
                         OIDplus::localpath().'res/redirect.ini'
                 );
+                        }
+                }
                 return false;
+        }
+        /**
+         * @param string $id
+         * @param array $out
+         * @param bool $handled
+         * @return void
+         * @throws OIDplusConfigInitializationException
+         * @throws OIDplusException
+         */
-        public function gui($id, &$out, &$handled) {
+        public function gui(string $id, array &$out, bool &$handled) {
                 if (explode('$',$id,2)[0] === 'oidplus:resources') {
                         $handled = true;
                         $tmp = explode('$',$id);
                         $file = isset($tmp[1]) ? $tmp[1] : '';
                                         $out['text'] .= self::getDocumentContent($file);
                                 } else {
                                         $out['title'] = _L('Unknown file type');
                                         $out['icon'] = 'img/error.png';
                                         $out['text'] = '<p>'._L('The system does not know how to handle this file type.').'</p>';
-                                        return;
+                                }
                         } else if (is_dir($realfile)) {
                                 $out['title'] = ($file == '') ? $this->getMainTitle() : self::getFolderTitle($realfile);
                                 if ($file == '') {
                                 $out['text'] = '<p>'._L('This resource doesn\'t exist anymore.').'</p>';
+                        }
+                }
+        }
+        /**
+         * @param $children
+         * @param ?string $rootdir
+         * @param int $depth
+         * @return void
+         * @throws OIDplusConfigInitializationException
+         * @throws OIDplusException
+         */
-        private function tree_rec(&$children, $rootdir=null, $depth=0) {
+        private function tree_rec(&$children, string $rootdir=null, int $depth=0)/*: void*/ {
                 if (is_null($rootdir)) $rootdir = '';
-                if ($depth > 100) return false; // something is wrong!
+                if ($depth > 100) return; // something is wrong!
                 $dirs = self::myglob($rootdir.'*'.'/', true);
                 natcasesort($dirs);
                 foreach ($dirs as $dir) {
                         $tmp = array();
                                 );
+                        }
+                }
+        }
+        /**
+         * @param $json
+         * @param $out
+         * @return void
+         */
         private function publicSitemap_rec($json, &$out) {
                 foreach ($json as $x) {
                         if (isset($x['id']) && $x['id']) {
                                 $out[] = $x['id'];
+                        }
                                 $this->publicSitemap_rec($x['children'], $out);
+                        }
+                }
+        }
+        /**
+         * @param array $out
+         * @return void
+         */
-        public function publicSitemap(&$out) {
+        public function publicSitemap(array &$out) {
                 $json = array();
-                $this->tree($json, null/*RA EMail*/, false/*HTML tree algorithm*/, true/*display all*/);
+                $this->tree($json, null/*RA EMail*/, false/*HTML tree algorithm*/, "*"/*display all*/);
                 $this->publicSitemap_rec($json, $out);
+        }
+        /**
+         * @param array $json
+         * @param string|null $ra_email
+         * @param bool $nonjs
+         * @param string $req_goto
+         * @return bool
+         * @throws OIDplusConfigInitializationException
+         * @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 {
                 $children = array();
                 $this->tree_rec($children, '/');
                 if (!OIDplus::config()->getValue('resource_plugin_hide_empty_path', true) || (count($children) > 0)) {
+                }
                 return true;
+        }
+        /**
+         * @param string $request
+         * @return array|false
+         */
-        public function tree_search($request) {
+        public function tree_search(string $request) {
                 return false;
+        }
+        /**
+         * @param $file
+         * @return array|mixed|string|string[]|null
+         * @throws OIDplusConfigInitializationException
+         * @throws OIDplusException
+         */
         private static function getHyperlinkTitle($file) {
                 $file2 = preg_replace('/\.([^.]+)$/', '$'.OIDplus::getCurrentLang().'.\1', $file);
                 if (file_exists($file2)) $file = $file2;
                 if (substr($file,-4,4) == '.url') {
                 } else {
                         throw new OIDplusException(_L('Unexpected file extension for file %1',$file));
+                }
+        }
+        /**
+         * @param $file
+         * @return mixed
+         * @throws OIDplusConfigInitializationException
+         * @throws OIDplusException
+         */
         private static function getHyperlinkURL($file) {
                 $file2 = preg_replace('/\.([^.]+)$/', '$'.OIDplus::getCurrentLang().'.\1', $file);
                 if (file_exists($file2)) $file = $file2;
                 if (substr($file,-4,4) == '.url') {
                         throw new OIDplusException(_L('Unexpected file extension for file %1',$file));
+                }
+        }
+        /**
+         * @param $dir
+         * @return mixed|string
+         * @throws OIDplusConfigInitializationException
+         * @throws OIDplusException
+         */
         private static function getFolderTitle($dir) {
                 $data = @parse_ini_file("$dir/folder\$".OIDplus::getCurrentLang().".ini", true);
                 if ($data && isset($data['Folder']) && isset($data['Folder']['Title'])) {
                         return $data['Folder']['Title'];
+                }

Subversion Repositories oidplus

oidplus/trunk/plugins/viathinksoft/publicPages/500_resources/OIDplusPagePublicResources.class.php – Rev 1086 → 1116