OpencachingDeutschland / oc-server3

htdocs/okapi/services/caches/map/tile.php

Doc Comments +4 added lines

@@ -55,6 +55,10 @@
         );
     }
 
+    /**
+     * @param OkapiRequest $request
+     * @param string $name
+     */
     private static function require_uint($request, $name, $min_value = 0)
     {
         $val = $request->get_parameter($name);

htdocs/okapi/services/caches/map/tilerenderer.inc.php

Doc Comments +12 added lines

@@ -38,6 +38,7 @@ 
      * Takes the zoom level and the list of geocache descriptions. Note, that
      * $rows_ref can be altered after calling render. If you don't want it to,
      * you should pass a deep copy.
+     * @param integer $zoom
      */
     public function __construct($zoom, &$rows_ref)
     {
@@ -101,6 +102,9 @@ 
         return ob_get_clean();
     }
 
+    /**
+     * @param string $name
+     */
     private static function get_image($name, $opacity=1, $brightness=0,
         $contrast=0, $r=0, $g=0, $b=0)
     {
@@ -157,6 +161,8 @@ 
 
     /**
      * Extremely slow! Remember to cache the result!
+     * @param resource $im
+     * @param integer $ratio
      */
     private static function change_opacity($im, $ratio)
     {
@@ -295,6 +301,9 @@ 
 
     /**
      * Split lines so that they fit inside the specified width.
+     * @param string $font
+     * @param integer $size
+     * @param integer $maxWidth
      */
     private static function wordwrap($font, $size, $maxWidth, $text)
     {
@@ -503,6 +512,9 @@ 
         }
     }
 
+    /**
+     * @param boolean $extended_set
+     */
     private static function get_type_suffix($type, $extended_set)
     {
         switch ($type) {

htdocs/okapi/services/caches/map/tiletree.inc.php

Doc Comments +3 added lines

@@ -57,6 +57,9 @@
      * Note that $pixels can also be negative or >=256 (up to a margin of 32px).
      * Count is the number of other caches "eclipsed" by this geocache (such
      * eclipsed geocaches are not included in the result).
+     * @param integer $zoom
+     * @param integer $x
+     * @param integer $y
      */
     public static function query_fast($zoom, $x, $y, $set_id)
     {

htdocs/okapi/services/caches/save_personal_notes.php

Doc Comments +3 added lines

@@ -108,6 +108,9 @@
         return $str1 == $str2;
     }
 
+    /**
+     * @param string $new_notes
+     */
     private static function update_notes($cache_id, $user_id, $new_notes)
     {
         if (Settings::get('OC_BRANCH') == 'oc.de')

htdocs/okapi/services/caches/search/save.php

Doc Comments +2 added lines

@@ -24,6 +24,7 @@ 
     /**
      * Get [set_id, date_created, expires] for the given params_hash
      * (or [null, null, null] if not found).
+     * @param string $params_hash
      */
     private static function find_param_set($params_hash, $ref_max_age)
     {
@@ -92,6 +93,7 @@ 
     /**
      * Important: YOU HAVE TO make sure $tables and $where_conds don't contain
      * unescaped user-supplied data!
+     * @param string[] $tables
      */
     public static function get_set($tables, $joins, $where_conds, $min_store, $ref_max_age)
     {

htdocs/okapi/services/logs/images/add.php

Doc Comments +4 added lines

@@ -284,6 +284,10 @@
     }
 
 
+    /**
+     * @param string $image_uuid
+     * @param string $file_ext
+     */
     private static function db_insert_image(
         $consumer_key, $user_id,
         $log_internal_id, $image_uuid, $position, $caption, $is_spoiler, $file_ext)

htdocs/okapi/services/logs/images/log_images_common.inc.php

Doc Comments +7 added lines

@@ -17,6 +17,9 @@ 
 
 class LogImagesCommon
 {
+    /**
+     * @param OkapiRequest $request
+     */
     function validate_image_uuid($request)
     {
         $image_uuid = $request->get_parameter('image_uuid');
@@ -63,6 +66,9 @@ 
     }
 
 
+    /**
+     * @param OkapiRequest $request
+     */
     function validate_position($request)
     {
         $position = $request->get_parameter('position');
@@ -87,6 +93,7 @@ 
      *
      * This function is always called when adding images. When editing images,
      * it is called only for OCDE and if the position parameter was supplied.
+     * @param integer $end_offset
      */
 
     static function prepare_position($log_internal_id, $position, $end_offset)

htdocs/okapi/services/logs/submit.php

Doc Comments +7 added lines

@@ -713,6 +713,9 @@ 
         return Okapi::formatted_response($request, $result);
     }
 
+    /**
+     * @param integer $when
+     */
     private static function increment_cache_stats($cache_internal_id, $when, $logtype)
     {
         if (Settings::get('OC_BRANCH') == 'oc.de')
@@ -788,6 +791,10 @@ 
         }
     }
 
+    /**
+     * @param integer $when
+     * @param integer $text_html
+     */
     private static function insert_log_row(
         $consumer_key, $cache_internal_id, $user_internal_id, $logtype, $when,
         $formatted_comment, $text_html, $needs_maintenance2

htdocs/okapi/services/replicate/replicate_common.inc.php

Doc Comments +8 added lines

@@ -165,6 +165,7 @@ 
      * well as long as only log entry fields are replicated which update
      * some cache_logs column when changed (by OKAPI or OC code). See
      * https://github.com/opencaching/okapi/issues/382 for further discussion.
+     * @param string[] $geocache_ignored_fields
      */
     public static function verify_clog_consistency(
         $force_all=false, $geocache_ignored_fields = null
@@ -269,6 +270,13 @@ 
      * In normal mode, update the changelog and don't return anything.
      * In fulldump mode, return the generated changelog entries *instead* of
      * updating it.
+     * @param string $feeder_method
+     * @param string $object_type
+     * @param string $feeder_keys_param
+     * @param string $key_name
+     * @param string $fields
+     * @param boolean $fulldump_mode
+     * @param boolean $use_cache
      */
     private static function generate_changelog_entries($feeder_method, $object_type, $feeder_keys_param,
         $key_name, $key_values, $fields, $fulldump_mode, $use_cache, $cache_timeout = 86400)