OpencachingDeutschland / oc-server3

htdocs/lib2/pager.class.php

Doc Comments +10 added lines

@@ -18,6 +18,9 @@ 
     // Use {page} in link_url als placeholder for the selected page number
     // and/or {offset} for the 0-based data offset of the selected page.
 
+    /**
+     * @param string $link_url
+     */
     public function __construct($link_url, $min_pages_shown = 2, $max_pages_shown = 15)
     {
         global $tpl;
@@ -31,6 +34,10 @@ 
     }
 
 
+    /**
+     * @param double $current_page
+     * @param double $total_pages
+     */
     public function make_from_pagenr($current_page, $total_pages, $page_size = false)
     {
         global $tpl;
@@ -94,6 +101,9 @@ 
     }
 
 
+    /**
+     * @param boolean $page_size
+     */
     private function pagelink($page, $page_size)
     {
         return mb_ereg_replace(

Spacing +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
             $to_page = min($last_page, max($first_page, $current_page - $lrspan) + $this->max_pages_shown - 1);
             $from_page = max($first_page, $to_page - $this->max_pages_shown + 1);
 
-            for ($page = $from_page; $page <= $to_page; $page ++) {
+            for ($page = $from_page; $page <= $to_page; $page++) {
                 if ($page == $current_page) {
                     $pages[$page] = false;
                 } else {

htdocs/lib2/rowEditor.class.php

Doc Comments +50 added lines

@@ -19,6 +19,10 @@ 
 
     /* primaryKey may be an array
      */
+
+    /**
+     * @param string $sTable
+     */
     public function __construct($sTable)
     {
         $this->pk = array();
@@ -26,6 +30,11 @@ 
         $this->sTable = $sTable;
     }
 
+    /**
+     * @param string $sField
+     * @param boolean $bNullable
+     * @param integer $nInsertFunction
+     */
     public function addPKInt($sField, $nDefault, $bNullable, $nInsertFunction = RE_INSERT_NOTHING)
     {
         $this->pk[$sField] = array(
@@ -100,6 +109,11 @@ 
         );
     }
 
+    /**
+     * @param string $sField
+     * @param boolean $bNullable
+     * @param integer $nInsertFunction
+     */
     public function addInt($sField, $nDefault, $bNullable, $nInsertFunction = RE_INSERT_NOTHING)
     {
         $this->fields[$sField] = array(
@@ -112,6 +126,11 @@ 
         );
     }
 
+    /**
+     * @param string $sField
+     * @param integer $nDefault
+     * @param boolean $bNullable
+     */
     public function addFloat($sField, $nDefault, $bNullable, $nInsertFunction = RE_INSERT_NOTHING)
     {
         $this->fields[$sField] = array(
@@ -124,6 +143,11 @@ 
         );
     }
 
+    /**
+     * @param string $sField
+     * @param integer $nDefault
+     * @param boolean $bNullable
+     */
     public function addDouble($sField, $nDefault, $bNullable, $nInsertFunction = RE_INSERT_NOTHING)
     {
         $this->fields[$sField] = array(
@@ -136,6 +160,11 @@ 
         );
     }
 
+    /**
+     * @param string $sField
+     * @param boolean $bNullable
+     * @param integer $nInsertFunction
+     */
     public function addString($sField, $sDefault, $bNullable, $nInsertFunction = RE_INSERT_NOTHING)
     {
         $this->fields[$sField] = array(
@@ -148,6 +177,10 @@ 
         );
     }
 
+    /**
+     * @param string $sField
+     * @param boolean $bNullable
+     */
     public function addBoolean($sField, $bDefault, $bNullable, $nInsertFunction = RE_INSERT_NOTHING)
     {
         $this->fields[$sField] = array(
@@ -160,6 +193,11 @@ 
         );
     }
 
+    /**
+     * @param string $sField
+     * @param boolean $bNullable
+     * @param integer $nInsertFunction
+     */
     public function addDate($sField, $dDefault, $bNullable, $nInsertFunction = RE_INSERT_NOTHING)
     {
         $this->fields[$sField] = array(
@@ -339,6 +377,9 @@ 
         return join(' AND ', $fwhere);
     }
 
+    /**
+     * @param string $sField
+     */
     public function getValue($sField)
     {
         if (isset($this->pk[$sField])) {
@@ -353,6 +394,9 @@ 
         return $this->fields[$sField]['default'];
     }
 
+    /**
+     * @param string $sField
+     */
     public function getChanged($sField)
     {
         return $this->fields[$sField]['changed'];
@@ -367,6 +411,9 @@ 
         }
     }
 
+    /**
+     * @param string $sField
+     */
     public function setValue($sField, $sValue)
     {
         if ($this->bLoaded == false || ($this->bAddNew == false && $this->bExist == false)) {
@@ -556,6 +603,9 @@ 
         return $sql;
     }
 
+    /**
+     * @param string $field
+     */
     public function saveField($field)
     {
         if ($this->bLoaded == false || $this->bExist == false || $this->bAddNew == true) {

Spacing +2 added lines, -2 removed lines

@@ -9,7 +9,7 @@ 
 {
     public $sTable;
     public $sAutoIncrementField = null;
-    public $pk;     // (idx:name; type, default, nullable, value, insertfunction)
+    public $pk; // (idx:name; type, default, nullable, value, insertfunction)
     public $fields; // (idx:name; type, default, nullable, value, changed, insertfunction)
 
     // status var
@@ -254,7 +254,7 @@ 
             if ($i == $index) {
                 return $k;
             }
-            $i ++;
+            $i++;
         }
     }
 

htdocs/lib2/RSSParser.class.php

Doc Comments +1 added lines

@@ -13,6 +13,7 @@
      *
      * @param int    $items number of feeditems to parse from feed
      * @param string $url   url of the feed to parse
+     * @param boolean $includetext
      *
      * @return string $item feeditems as HTML-string
      */

Spacing +2 added lines, -2 removed lines

@@ -66,7 +66,7 @@ 
                                     'description' => $item->description
                                 );
                                 // increment counter
-                                $i ++;
+                                $i++;
                                 // htmlspecialchars_decode() works around inconsistent HTML encoding
                                 // e.g. in SMF Forum Threads
                             } elseif (!in_array(htmlspecialchars_decode($item->title), $headlines) &&
@@ -80,7 +80,7 @@ 
                                 );
                                 $headlines[] = "" . htmlspecialchars_decode($item->title);
                                 // increment counter
-                                $i ++;
+                                $i++;
                             }
                         }
                     }

htdocs/lib2/search/ftsearch.inc.php

Doc Comments +6 added lines

@@ -159,6 +159,9 @@ 
 }
 
 // str = long text
+/**
+ * @param boolean $simple
+ */
 function ftsearch_split(&$str, $simple)
 {
     global $ftsearch_ignores;
@@ -488,6 +491,9 @@ 
     sql("DELETE FROM `search_index_times` WHERE `object_type`='&1' AND `object_id`='&2'", $object_type, $object_id);
 }
 
+/**
+ * @param integer $object_type
+ */
 function ftsearch_set_entries($object_type, $object_id, $cache_id, &$text, $last_modified)
 {
     ftsearch_delete_entries($object_type, $object_id, $cache_id);

Spacing +2 added lines, -2 removed lines

@@ -188,7 +188,7 @@ 
     $str = '';
 
     ftsearch_load_ignores();
-    for ($i = count($astr) - 1; $i >= 0; $i --) {
+    for ($i = count($astr) - 1; $i >= 0; $i--) {
         // ignore?
         if (array_search(mb_strtolower($astr[$i]), $ftsearch_ignores) !== false) {
             unset($astr[$i]);
@@ -237,7 +237,7 @@ 
     }
 
     // doppelte chars ersetzen
-    for ($c = ord('a'); $c <= ord('z'); $c ++) {
+    for ($c = ord('a'); $c <= ord('z'); $c++) {
         $old_str = '';
         while ($old_str != $str) {
             $old_str = $str;

htdocs/lib2/search/search.gpx.inc.php

Doc Comments +3 added lines

@@ -569,6 +569,9 @@
     return $str;
 }
 
+/**
+ * @return string
+ */
 function changePlaceholder($str, $inverse = false)
 {
     static $translate = array(

Spacing +7 added lines, -7 removed lines

@@ -390,7 +390,7 @@ 
                 $thislog = mb_ereg_replace('{username}', text_xmlentities($rLog['username']), $thislog);
 
                 if ($rLog['type'] == 3 && $rLog['needs_maintenance'] == 2) {
-                    $logtype = 'Needs Maintenance';   // with capital M, other than cache attribute
+                    $logtype = 'Needs Maintenance'; // with capital M, other than cache attribute
                 } elseif (isset($gpxLogType[$rLog['type']])) {
                     $logtype = $gpxLogType[$rLog['type']];
                 } else {
@@ -511,28 +511,28 @@ 
             switch ($childWaypoint['type']) {
                 case 1:
                     $wp_typename = "Parking Area";
-                    break;  // well-known garmin symbols
+                    break; // well-known garmin symbols
                 case 2:
                     $wp_typename = "Flag, Green";
-                    break;   // stage / ref point
+                    break; // stage / ref point
                 case 3:
                     $wp_typename = "Flag, Blue";
-                    break;    // path
+                    break; // path
                 case 4:
                     $wp_typename = "Circle with X";
                     break; // final
                 case 5:
                     $wp_typename = "Diamond, Green";
-                    break;  // point of interest
+                    break; // point of interest
                 default:
                     $wp_typename = "Flag, Blue";
-                    break;  // for the case new types are forgotten here ..
+                    break; // for the case new types are forgotten here ..
             }
             $thiswp = mb_ereg_replace('{type}', text_xmlentities($wp_typename), $thiswp);
             $thiswp = mb_ereg_replace('{parent}', $r['waypoint'], $thiswp);
             $thiswp = mb_ereg_replace('{cacheid}', $r['cacheid'], $thiswp);
             $waypoints .= $thiswp;
-            ++ $n;
+            ++$n;
         }
 
         if ($cacheNote && !empty($cacheNote['latitude']) && !empty($cacheNote['longitude'])) {

htdocs/lib2/search/search.html.inc.php

Doc Comments +4 added lines

@@ -202,6 +202,10 @@
 }
 
 
+/**
+ * @param string $interval
+ * @param string $dateTimeEnd
+ */
 function dateDiff($interval, $dateTimeBegin, $dateTimeEnd)
 {
     //Parse about any English textual datetime

htdocs/lib2/search/search.xml.inc.php

Doc Comments +3 added lines

@@ -203,6 +203,9 @@
     return $str;
 }
 
+/**
+ * @param string $str
+ */
 function lf2crlf($str)
 {
     return str_replace("\r\r\n", "\r\n", str_replace("\n", "\r\n", $str));

htdocs/lib2/sqldebugger.class.php

Doc Comments +9 added lines

@@ -107,6 +107,9 @@ 
         return $rsResult;
     }
 
+    /**
+     * @param string $sql
+     */
     public function strip_temptable($sql)
     {
         $start = stripos($sql, 'SELECT ');
@@ -118,6 +121,9 @@ 
         return substr($sql, $start);
     }
 
+    /**
+     * @param string $sql
+     */
     public function strip_from($sql)
     {
         $start = stripos($sql, 'FROM ');
@@ -129,6 +135,9 @@ 
         return 'SELECT * ' . substr($sql, $start);
     }
 
+    /**
+     * @param string $sql
+     */
     public function insert_nocache($sql)
     {
         if (strtoupper(substr($sql, 0, 7)) == 'SELECT ') {

Spacing +1 added lines, -1 removed lines

@@ -74,7 +74,7 @@
                     break;
                 }
                 $command['result'][] = $r;
-                $c ++;
+                $c++;
             }
             sql_free_result($rs);
 

htdocs/lib2/ss_zip.class.php

Doc Comments +5 added lines, -1 removed lines

@@ -283,7 +283,7 @@ 
     /** Removes entry from the archive.
      * please be very carefull with this function, there is no undo after you save the archive
      *
-     * @return bool true on success or false on failure
+     * @return boolean|null true on success or false on failure
      *
      * @param int $idx
      */
@@ -334,6 +334,10 @@ 
         return $idx >= 0 and $idx < $this->cnt;
     }
 
+    /**
+     * @param string $name
+     * @param string $data
+     */
     public function _write($name, $data)
     {
         $fp = fopen($name, "w");

Spacing +9 added lines, -9 removed lines

@@ -143,9 +143,9 @@ 
 
         }
         $fnl = strlen($filename);
-        $fh = "\x14\x00";    // ver needed to extract
-        $fh .= "\x00\x00";    // gen purpose bit flag
-        $fh .= "\x08\x00";    // compression method
+        $fh = "\x14\x00"; // ver needed to extract
+        $fh .= "\x00\x00"; // gen purpose bit flag
+        $fh .= "\x08\x00"; // compression method
         $fh .= "\x00\x00\x00\x00"; // last mod time and date
         $fh .= pack(
             "V3v2",
@@ -170,16 +170,16 @@ 
                 "va*v3V2",
                 0,
                 $fh,
-                0,        // file comment length
-                0,        // disk number start
-                0,        // internal file attributes
-                $attr,    // external file attributes - 'archive/directory' bit set
+                0, // file comment length
+                0, // disk number start
+                0, // internal file attributes
+                $attr, // external file attributes - 'archive/directory' bit set
                 $this->offset
             ) . $filename;
 
         $this->offset += 42 + $fnl + $gzsize;
         $this->cdir[] = $cdir;
-        $this->cnt ++;
+        $this->cnt++;
         $this->idx = $this->cnt - 1;
     }
 
@@ -228,7 +228,7 @@ 
                 $cdsl, // size of central dir
                 $zdsl, // offset to start of central dir
                 0
-            );              // .zip file comment length
+            ); // .zip file comment length
         return $this->zipfile;
     }