WebSVN – oidplus – Diff – /trunk/plugins/viathinksoft/adminPages/400_oidinfo_export/OIDplusPageAdminOIDInfoExport.class.php

 class OIDplusPageAdminOIDInfoExport extends OIDplusPagePluginAdmin {
         /*private*/ const QUERY_LIST_OIDINFO_OIDS_V1 = '1.3.6.1.4.1.37476.2.5.2.1.5.1';
         /*private*/ const QUERY_GET_OIDINFO_DATA_V1  = '1.3.6.1.4.1.37476.2.5.2.1.6.1';
+        /**
+         * @param string $actionID
+         * @param array $params
+         * @return array|int[]
+         * @throws OIDplusException
+         */
-        public function action($actionID, $params) {
+        public function action(string $actionID, array $params): array {
                 if ($actionID == 'import_xml_file') {
                         if (!OIDplus::authUtils()->isAdminLoggedIn()) {
                                 throw new OIDplusException(_L('You need to <a %1>log in</a> as administrator.',OIDplus::gui()->link('oidplus:login$admin')));
+                        }
                                 return array("status" => -1, "error" => _L('Imported %1, but expected to import 1',$count_imported_oids));
                         } else {
                                 return array("status" => 0);
+                        }
                 } else {
-                        throw new OIDplusException(_L('Unknown action ID'));
+                        return parent::action($actionID, $params);
+                }
+        }
+        /**
+         * @param bool $html
+         * @return void
+         */
-        public function init($html=true) {
+        public function init(bool $html=true) {
                 // Nothing
+        }
+        /**
+         * @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) {
                 $ary = explode('$', $id);
                 if (isset($ary[1])) {
                         $id = $ary[0];
                         $tab = $ary[1];
                 } else {
                         $out['text'] .= '</div></div><script>$("#dataTransferArea")[0].style.visibility = "visible";</script>';
+                }
+        }
+        /**
+         * @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 $only_non_existing
+         * @return string[]
+         * @throws OIDplusException
+         * @throws \OIDInfoException
+         */
         public static function outputXML($only_non_existing) {
                 $out_type = null;
                 $out_content = '';
                 // This file contains class \OIDInfoAPI.
                 $out_type = 'text/xml';
                 return array($out_content, $out_type);
+        }
+        /**
+         * @param $str
+         * @return mixed|string
+         */
         private static function _formatdate($str) {
                 $str = explode(' ',$str)[0];
                 if ($str == '0000-00-00') $str = '';
                 return $str;
+        }
+        /**
+         * @param $str
+         * @return array|string|string[]|null
+         * @throws OIDplusException
+         */
         private static function repair_relative_links($str) {
                 $str = preg_replace_callback('@(href\s*=\s*([\'"]))(.+)(\\2)@ismU', function($treffer) {
                         $url = $treffer[3];
                         if ((stripos($url,'http:') !== 0) && (stripos($url,'https:') !== 0) && (stripos($url,'ftp:') !== 0)) {
                                 if (stripos($url,'www.') === 0) {
                         return $treffer[1].$url.$treffer[4];
                 }, $str);
                 return $str;
+        }
+        /**
+         * @param $address
+         * @return array|string[]
+         */
         private static function split_address_country($address) {
                 global $oidinfo_countries;
                 $ary = explode("\n", $address);
                 $last_line = array_pop($ary);
                 $rest = implode("\n", $ary);
                 } else {
                         return array($rest."\n".$last_line, '');
+                }
+        }
+        /**
+         * @param $name
+         * @return array
+         */
         private static function split_name($name) {
                 // uses regex that accepts any word character or hyphen in last name
                 // https://stackoverflow.com/questions/13637145/split-text-string-into-first-and-last-name-in-php
                 $name = trim($name);
                 $last_name = (strpos($name, ' ') === false) ? '' : preg_replace('#.*\s([\w-]*)$#', '$1', $name);
         /*protected*/ const ORPHAN_IGNORE = 0;
         /*protected*/ const ORPHAN_AUTO_DEORPHAN = 1;
         /*protected*/ const ORPHAN_DISALLOW_ORPHANS = 2;
+        /**
+         * @param $xml_contents
+         * @param $errors
+         * @param $replaceExistingOIDs
+         * @param $orphan_mode
+         * @return array|int[]
+         * @throws OIDplusException
+         */
         protected function oidinfoImportXML($xml_contents, &$errors, $replaceExistingOIDs=false, $orphan_mode=self::ORPHAN_AUTO_DEORPHAN) {
                 // TODO: Implement RA import (let the user decide)
                 // TODO: Let the user decide about $replaceExistingOIDs
                 // TODO: Let the user decide if "created=now" should be set (this is good when the XML files is created by the user itself to do bulk-inserts)
                 return array($count_imported_oids, $count_already_existing, $count_errors, $count_warnings);
+        }
+        /**
+         * @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;
+        }
+        /**
+         * Implements interface 1.3.6.1.4.1.37476.2.5.2.3.8
+         * @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
                 $notifications = array();
                 if ((!$user || ($user == 'admin')) && OIDplus::authUtils()->isAdminLoggedIn()) {
                         if (!function_exists('curl_init')) {
                                 $title = _L('OID-Info.com import/export');
                                 $notifications[] = array('ERR', _L('OIDplus plugin "%1" is enabled, but the required PHP extension "%2" is not installed.', '<a '.OIDplus::gui()->link('oidplus:datatransfer').'>'.htmlentities($title).'</a>', 'php_curl'));

Subversion Repositories oidplus

oidplus/trunk/plugins/viathinksoft/adminPages/400_oidinfo_export/OIDplusPageAdminOIDInfoExport.class.php – Rev 1086 → 1116