OpencachingDeutschland / oc-server3

htdocs/lib2/translate_filescan.class.php

Doc Comments +8 added lines

@@ -76,6 +76,10 @@ 
         }
     }
 
+    /**
+     * @param string $sCode
+     * @param integer $nStartSearch
+     */
     public function findEndOfPHPString($sCode, $nStartSearch)
     {
         $nEnd = 0;
@@ -116,6 +120,10 @@ 
     }
 
     // TODO: performance ... scan once at __construct and store line positions
+
+    /**
+     * @param integer $nPos
+     */
     public function findLineOfPos($nPos)
     {
         $nLine = 1;

htdocs/lib2/util.inc.php

Doc Comments +13 added lines

@@ -246,11 +246,21 @@ 
     return $ret;
 }
 
+/**
+ * @param string $name
+ * @param string $default
+ *
+ * @return string
+ */
 function getSysConfig($name, $default)
 {
     return sql_value("SELECT `value` FROM `sysconfig` WHERE `name`='&1'", $default, $name);
 }
 
+/**
+ * @param string $name
+ * @param string $value
+ */
 function setSysConfig($name, $value)
 {
     sql(
@@ -333,6 +343,9 @@ 
 }
 
 
+/**
+ * @return string
+ */
 function escape_javascript($text)
 {
     return str_replace('\'', '\\\'', str_replace('"', '"', $text));

htdocs/mydetails.php

Doc Comments +3 added lines

@@ -128,6 +128,9 @@
 }
 
 
+/**
+ * @param boolean $include_editor
+ */
 function assignFromDB($userid, $include_editor)
 {
     global $tpl, $opt, $smilies, $_REQUEST;

htdocs/myprofile.php

Doc Comments +3 added lines

@@ -182,6 +182,9 @@
     $tpl->display();
 }
 
+/**
+ * @param user $user
+ */
 function assignFromUser($user)
 {
     global $tpl;

htdocs/restorecaches.php

Doc Comments +1 added lines, -1 removed lines

@@ -675,7 +675,7 @@
  * @param $admins
  * @param $wp_oc
  * @param $r
- * @param $field
+ * @param string $field
  * @param $oldvalue
  * @param $newvalue
  */

Indentation +1 added lines, -1 removed lines

@@ -1011,7 +1011,7 @@
                             }
                             $logs_restored = true;
                         }
-                       // if it was not already restored by a later restore operation ...
+                        // if it was not already restored by a later restore operation ...
                     } elseif (sql_value("SELECT `id` FROM `cache_logs` WHERE `id`='&1'", 0, $revert_logid) == 0) {
                         // id, uuid, date_created and last_modified are set automatically;
                         // picture will be updated automatically on picture-restore

Spacing +7 added lines, -7 removed lines

@@ -367,7 +367,7 @@ 
     $rs = sql('SELECT * FROM `caches` WHERE `cache_id` IN ' . $cachelist);
     while ($r = sql_fetch_assoc($rs)) {
         $nextcd[$r['wp_oc']] = $r;
-        $user_id = $r['user_id'];     // is used later for logs
+        $user_id = $r['user_id']; // is used later for logs
     }
     sql_free_result($rs);
 
@@ -467,7 +467,7 @@ 
         "SELECT * FROM `caches_attributes_modified`
          WHERE `cache_id` IN " . $cachelist . "  /* OConly attrib is shown, but not restorable */
          ORDER BY `date_modified` ASC"
-    );   // order doesn't matter as long it is date only
+    ); // order doesn't matter as long it is date only
     while ($r = sql_fetch_assoc($rs)) {
         append_data(
             $data,
@@ -623,7 +623,7 @@ 
         'SELECT *, ' . $piccacheid . "AS `cache_id` FROM `pictures_modified`
          WHERE " . $piccacheid . ' IN ' . $cachelist . "
          ORDER BY `date_modified` ASC"
-    );  // order is relevant for the case of restore-reverts
+    ); // order is relevant for the case of restore-reverts
     while ($r = sql_fetch_assoc($rs)) {
         $r['date_modified'] = substr($r['date_modified'], 0, 10);
         switch ($r['operation']) {
@@ -727,7 +727,7 @@ 
 {
     global $opt, $login;
 
-    sql("SET @restoredby='&1'", $login->userid);         // is evaluated by trigger functions
+    sql("SET @restoredby='&1'", $login->userid); // is evaluated by trigger functions
     sql_slave("SET @restoredby='&1'", $login->userid);
 
     $restored = [];
@@ -1019,7 +1019,7 @@ 
                         // id, uuid, date_created and last_modified are set automatically;
                         // picture will be updated automatically on picture-restore
                         $log = new cachelog();
-                        $log->setNode($r['node']);  // cachelog class currently does not initialize node field
+                        $log->setNode($r['node']); // cachelog class currently does not initialize node field
                         $log->setCacheId($r['cache_id']);
                         $log->setUserId($r['user_id']);
                         $log->setType($r['type'], true);
@@ -1071,7 +1071,7 @@ 
                 }  // not already processed
 
                 if ($error != '') {
-                    $restored[$wp]['internal error - could not $error log ' + $r['id'] + '/' + $logid];
+                    $restored[$wp]['internal error - could not $error log ' +$r['id'] + '/' +$logid];
                 }
                 if ($logs_restored) {
                     $restored[$wp]['logs'] = true;
@@ -1203,7 +1203,7 @@ 
                 }  // not already processed
 
                 if ($error != '') {
-                    $restored[$wp]['internal error - could not $error picture ' . $r['id'] + '/' + $picid] = true;
+                    $restored[$wp]['internal error - could not $error picture ' . $r['id'] + '/' +$picid] = true;
                 }
                 if ($pics_restored) {
                     $restored[$wp]['pictures'] = true;

htdocs/search.php

Doc Comments +4 added lines

@@ -1461,6 +1461,10 @@
         }
 
         // helper function for output modules
+
+        /**
+         * @param string $str
+         */
         function append_output($str)
         {
             global $db, $content, $bUseZip;

Spacing +15 added lines, -15 removed lines

@@ -128,7 +128,7 @@ 
     }
 }
 
-$queryid += 0;  // safety measure: force $queryid to be numeric
+$queryid += 0; // safety measure: force $queryid to be numeric
 
 
 //=========================================================
@@ -149,7 +149,7 @@ 
     if (sql_num_rows($query_rs) == 0) {
         // can happen if logged out after query was created (fix for RT #3915)
         $queryid = 0;
-        goto newquery;  // goto needs PHP 5.3
+        goto newquery; // goto needs PHP 5.3
         /*
         $tpl->error($error_query_not_found);
         */
@@ -185,7 +185,7 @@ 
         }
 
         // get findername from finderid
-        $options['finderid'] = isset($options['finderid']) ? $options['finderid'] + 0 : 0;  // Ocprop
+        $options['finderid'] = isset($options['finderid']) ? $options['finderid'] + 0 : 0; // Ocprop
         if (isset($options['finder']) && $options['finderid'] > 0) {
             $rs_name = sql("SELECT `username` FROM `user` WHERE `user_id`='&1'", $options['finderid']);
             if (sql_num_rows($rs_name) == 1) {
@@ -197,7 +197,7 @@ 
         }
 
         // get ownername from ownerid
-        $options['ownerid'] = isset($options['ownerid']) ? $options['ownerid'] + 0 : 0;  // Ocprop
+        $options['ownerid'] = isset($options['ownerid']) ? $options['ownerid'] + 0 : 0; // Ocprop
         if (isset($options['owner']) && $options['ownerid'] > 0) {
             $rs_name = sql("SELECT `username` FROM `user` WHERE `user_id`='&1'", $options['ownerid']);
             if (sql_num_rows($rs_name) == 1) {
@@ -226,10 +226,10 @@ 
     }
 
     // get the search options parameters and store them in the queries table (to view "the next page")
-    $options['f_userowner'] = isset($_REQUEST['f_userowner']) ? $_REQUEST['f_userowner'] : 0;  // Ocprop
-    $options['f_userfound'] = isset($_REQUEST['f_userfound']) ? $_REQUEST['f_userfound'] : 0;  // Ocprop
+    $options['f_userowner'] = isset($_REQUEST['f_userowner']) ? $_REQUEST['f_userowner'] : 0; // Ocprop
+    $options['f_userfound'] = isset($_REQUEST['f_userfound']) ? $_REQUEST['f_userfound'] : 0; // Ocprop
     $options['f_disabled'] = isset($_REQUEST['f_disabled']) ? $_REQUEST['f_disabled'] : 0;
-    $options['f_inactive'] = isset($_REQUEST['f_inactive']) ? $_REQUEST['f_inactive'] : 1;  // Ocprop
+    $options['f_inactive'] = isset($_REQUEST['f_inactive']) ? $_REQUEST['f_inactive'] : 1; // Ocprop
     // f_inactive formerly was used for both, archived and disabled caches.
     // After adding the separate f_disabled option, it is used only for archived
     // caches, but keeps its name for compatibility with existing stored or
@@ -237,9 +237,9 @@ 
     $options['f_ignored'] = isset($_REQUEST['f_ignored']) ? $_REQUEST['f_ignored'] : 1;
     $options['f_otherPlatforms'] = isset($_REQUEST['f_otherPlatforms']) ? $_REQUEST['f_otherPlatforms'] : 0;
     $options['f_geokrets'] = isset($_REQUEST['f_geokrets']) ? $_REQUEST['f_geokrets'] : 0;
-    $options['expert'] = isset($_REQUEST['expert']) ? $_REQUEST['expert'] : 0;  // Ocprop: 0
+    $options['expert'] = isset($_REQUEST['expert']) ? $_REQUEST['expert'] : 0; // Ocprop: 0
     $options['showresult'] = isset($_REQUEST['showresult']) ? $_REQUEST['showresult'] : 0;
-    $options['output'] = isset($_REQUEST['output']) ? $_REQUEST['output'] : 'HTML';  // Ocprop: HTML
+    $options['output'] = isset($_REQUEST['output']) ? $_REQUEST['output'] : 'HTML'; // Ocprop: HTML
     $options['bbox'] = isset($_REQUEST['bbox']) ? $_REQUEST['bbox'] : false;
 
     if (isset($_REQUEST['cache_attribs'])) {
@@ -297,7 +297,7 @@ 
 
         $options['finderid'] = isset($_REQUEST['finderid']) ? $_REQUEST['finderid'] : 0;
         $options['finder'] = isset($_REQUEST['finder']) ? stripslashes($_REQUEST['finder']) : '';
-        $options['logtype'] = isset($_REQUEST['logtype']) ? $_REQUEST['logtype'] : '1,7';  // Ocprop
+        $options['logtype'] = isset($_REQUEST['logtype']) ? $_REQUEST['logtype'] : '1,7'; // Ocprop
     } elseif (isset($_REQUEST['searchbyortplz'])) {
         $onlydigits = is_numeric($_REQUEST['ortplz']);
         if ($onlydigits == true) {
@@ -363,7 +363,7 @@ 
         if (!$list->allowView($password)) {
             $tpl->redirect('cachelists.php');
         }
-        $options['cachelist'] = cachelist::getListById($options['listid']);  // null for invalid ID
+        $options['cachelist'] = cachelist::getListById($options['listid']); // null for invalid ID
         $options['cachelist_pw'] = $password;
     } elseif (isset($_REQUEST['searchall'])) {
         if (!$login->logged_in() &&
@@ -1243,7 +1243,7 @@ 
     //  X6. load output module and output-dependent options
     //=================================================================
 
-    $output_module = mb_strtolower($options['output']);  // Ocprop: HTML, gpx
+    $output_module = mb_strtolower($options['output']); // Ocprop: HTML, gpx
 
     $map2_bounds = ($output_module == 'map2bounds');
     if ($map2_bounds) {
@@ -1785,9 +1785,9 @@ 
     }
     $tpl->assign('ortplz', $ortplz);
     if ($options['searchtype'] == 'byplz') {
-        $dByOrtPlzChecked = ($options['searchtype'] == 'byplz');  // Ocprop
+        $dByOrtPlzChecked = ($options['searchtype'] == 'byplz'); // Ocprop
     } elseif ($options['searchtype'] == 'byort') {
-        $dByOrtPlzChecked = ($options['searchtype'] == 'byort');  // Ocprop
+        $dByOrtPlzChecked = ($options['searchtype'] == 'byort'); // Ocprop
     } else {
         $dByOrtPlzChecked = false;
     }
@@ -2278,7 +2278,7 @@ 
 
 function outputUniidSelectionForm($uniSql, $options)
 {
-    global $tpl;  // settings
+    global $tpl; // settings
     global $locline, $secondlocationname;
 
     $urlparamString = prepareLocSelectionForm($options);

htdocs/src/Oc/Libse/ChildWp/PresenterChildWp.php

Doc Comments +6 added lines

@@ -54,6 +54,9 @@ 
         $this->onDoSubmit($this->coordinate->getCoordinate(), $this->getDesc());
     }
 
+    /**
+     * @param \Oc\Libse\Coordinate\CoordinateCoordinate $coordinate
+     */
     abstract protected function onDoSubmit($coordinate, $description);
 
     protected function getType()
@@ -74,6 +77,9 @@ 
         $this->typeImages = $childWpHandler->getChildNamesAndImages();
     }
 
+    /**
+     * @param \Oc\Libse\Coordinate\CoordinateCoordinate $coords
+     */
     public function initCoordinate($coords)
     {
         $this->coordinate->init($coords->latitude(), $coords->longitude());

htdocs/src/Oc/Libse/Coordinate/PresenterCoordinate.php

Doc Comments +6 added lines

@@ -35,6 +35,9 @@ 
         $this->init(0, 0);
     }
 
+    /**
+     * @param boolean $request
+     */
     private function initRequest($request)
     {
         if ($request) {
@@ -44,6 +47,9 @@ 
         return new RequestHttp();
     }
 
+    /**
+     * @param boolean $translator
+     */
     private function initTranslator($translator)
     {
         if ($translator) {

htdocs/translate.php

Doc Comments +16 added lines

@@ -245,6 +245,9 @@ 
 /* $truncatLastInsert = true   for downloaded file
  * $truncatLastInsert = false  to sign self generated file (in function export)
  */
+/**
+ * @param boolean $truncateLastInsert
+ */
 function calcDataSqlChecksum($truncateLastInsert)
 {
     global $opt;
@@ -390,6 +393,10 @@ 
     $tpl->redirect('translate.php?translang=' . $translang);
 }
 
+/**
+ * @param string $relbasedir
+ * @param string $ext
+ */
 function unlinkFiles($relbasedir, $ext)
 {
     global $opt;
@@ -481,6 +488,9 @@ 
     $tpl->redirect('translate.php?translang=' . $translang);
 }
 
+/**
+ * @param integer $freeId
+ */
 function useId($freeId)
 {
     $lastId = sql_value("SELECT MAX(`id`) FROM `sys_trans`", 0);
@@ -490,6 +500,9 @@ 
     setId($lastId, $freeId);
 }
 
+/**
+ * @param integer $oldId
+ */
 function setId($oldId, $newId)
 {
     global $transIdCols;
@@ -568,6 +581,9 @@ 
     $tpl->redirect('translate.php?translang=' . $translang);
 }
 
+/**
+ * @param string $dir
+ */
 function enumSqlFiles($dir)
 {
     $retval = [];

Switch Indentation +100 added lines, -100 removed lines

@@ -86,69 +86,69 @@ 
 }
 
 switch ($action) {
-    case 'selectlang':
-        break;
+        case 'selectlang':
+            break;
 
-    case 'verify':
-        verify();
-        break;
+        case 'verify':
+            verify();
+            break;
 
-    case 'resetids':
-        resetIds();
-        break;
+        case 'resetids':
+            resetIds();
+            break;
 
-    case 'clearcache':
-        clearCache();
-        break;
+        case 'clearcache':
+            clearCache();
+            break;
 
-    case 'export':
-        export();
-        break;
+        case 'export':
+            export();
+            break;
 
-    case 'xmlexport':
-        xmlexport();
-        break;
+        case 'xmlexport':
+            xmlexport();
+            break;
 
-    case 'xmlimport':
-        break;
+        case 'xmlimport':
+            break;
 
-    case 'xmlimport2':
-        xmlimport2();
-        break;
+        case 'xmlimport2':
+            xmlimport2();
+            break;
 
-    case 'xmlimport3':
-        xmlimport3();
-        break;
+        case 'xmlimport3':
+            xmlimport3();
+            break;
 
-    case 'textexportnew':
-        textexport($translang, false);
-        break;
+        case 'textexportnew':
+            textexport($translang, false);
+            break;
 
-    case 'textexportall':
-        textexport($translang, true);
-        break;
+        case 'textexportall':
+            textexport($translang, true);
+            break;
 
-    case 'textimport':
-        break;
+        case 'textimport':
+            break;
 
-    case 'textimport2':
-        textimport($translang);
-        break;
+        case 'textimport2':
+            textimport($translang);
+            break;
 
-    case 'edit':
-        if (!$access->mayTranslate($translang)) {
-            $tpl->error(ERROR_NO_ACCESS);
-        }
-        edit();
-        break;
+        case 'edit':
+            if (!$access->mayTranslate($translang)) {
+                $tpl->error(ERROR_NO_ACCESS);
+            }
+            edit();
+            break;
 
-    case 'copy_en':
-        copy_english_texts();
-        break;
+        case 'copy_en':
+            copy_english_texts();
+            break;
 
-    case 'listfaults':
-        $trans = sql(
-            "SELECT
+        case 'listfaults':
+            $trans = sql(
+                "SELECT
                 `sys_trans`.`id`,
                 `sys_trans`.`text`
              FROM `sys_trans`
@@ -156,14 +156,14 @@ 
                 ON `sys_trans`.`id`=`sys_trans_ref`.`trans_id`
              WHERE ISNULL(`sys_trans_ref`.`trans_id`)
              ORDER BY `sys_trans`.`id` DESC"
-        );
-        $tpl->assign_rs('trans', $trans);
-        sql_free_result($trans);
-        break;
+            );
+            $tpl->assign_rs('trans', $trans);
+            sql_free_result($trans);
+            break;
 
-    case 'listall':
-        $trans = sql(
-            "SELECT
+        case 'listall':
+            $trans = sql(
+                "SELECT
                 `sys_trans`.`id`,
                 `sys_trans`.`text`,
                 `sys_trans_text`.`text` AS `trans`
@@ -172,48 +172,48 @@ 
                 ON `sys_trans`.`id`=`sys_trans_text`.`trans_id`
                 AND `sys_trans_text`.`lang`='&1'
              ORDER BY `sys_trans`.`id` DESC",
-            $translang
-        );
-        $tpl->assign_rs('trans', $trans);
-        sql_free_result($trans);
-        break;
+                $translang
+            );
+            $tpl->assign_rs('trans', $trans);
+            sql_free_result($trans);
+            break;
 
-    case 'remove':
-        if (!$access->mayTranslate($translang)) {
-            $tpl->error(ERROR_NO_ACCESS);
-        }
-        remove();
-        break;
-
-    case 'scan':
-        scan();
-        break;
-
-    case 'scanstart':
-        scanStart();
-        break;
-
-    case 'scanfile':
-        $filename = isset($_REQUEST['filename']) ? $_REQUEST['filename'] : '';
-        scanFile($filename);
-        exit;
-
-    case 'quicknone':
-        $cookie->un_set('translate_mode');
-        break;
-
-    case 'quicknew':
-        $cookie->set('translate_mode', 'new');
-        break;
-
-    case 'quickall':
-        $cookie->set('translate_mode', 'all');
-        break;
-
-    default:
-        $action = 'listnew';
-        $trans = sql(
-            "SELECT DISTINCT
+        case 'remove':
+            if (!$access->mayTranslate($translang)) {
+                $tpl->error(ERROR_NO_ACCESS);
+            }
+            remove();
+            break;
+
+        case 'scan':
+            scan();
+            break;
+
+        case 'scanstart':
+            scanStart();
+            break;
+
+        case 'scanfile':
+            $filename = isset($_REQUEST['filename']) ? $_REQUEST['filename'] : '';
+            scanFile($filename);
+            exit;
+
+        case 'quicknone':
+            $cookie->un_set('translate_mode');
+            break;
+
+        case 'quicknew':
+            $cookie->set('translate_mode', 'new');
+            break;
+
+        case 'quickall':
+            $cookie->set('translate_mode', 'all');
+            break;
+
+        default:
+            $action = 'listnew';
+            $trans = sql(
+                "SELECT DISTINCT
                 `sys_trans`.`id`,
                 `sys_trans`.`text`
              FROM `sys_trans`
@@ -224,10 +224,10 @@ 
                 ON `sys_trans`.`id`=`sys_trans_ref`.`trans_id`
              WHERE ISNULL(`sys_trans_text`.`trans_id`) OR `sys_trans_text`.`text`=''
              ORDER BY `sys_trans`.`id` DESC",
-            $translang
-        );
-        $tpl->assign_rs('trans', $trans);
-        sql_free_result($trans);
+                $translang
+            );
+            $tpl->assign_rs('trans', $trans);
+            sql_free_result($trans);
 }
 
 $languages = [];