Completed
Pull Request — master (#313)
by Thomas
18:19 queued 08:41
created
htdocs/okapi/services/caches/map/tiletree.inc.php 1 patch
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -57,6 +57,9 @@
 block discarded – undo
57 57
      * Note that $pixels can also be negative or >=256 (up to a margin of 32px).
58 58
      * Count is the number of other caches "eclipsed" by this geocache (such
59 59
      * eclipsed geocaches are not included in the result).
60
+     * @param integer $zoom
61
+     * @param integer $x
62
+     * @param integer $y
60 63
      */
61 64
     public static function query_fast($zoom, $x, $y, $set_id)
62 65
     {
Please login to merge, or discard this patch.
htdocs/okapi/services/caches/save_personal_notes.php 1 patch
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -108,6 +108,9 @@
 block discarded – undo
108 108
         return $str1 == $str2;
109 109
     }
110 110
 
111
+    /**
112
+     * @param string $new_notes
113
+     */
111 114
     private static function update_notes($cache_id, $user_id, $new_notes)
112 115
     {
113 116
         if (Settings::get('OC_BRANCH') == 'oc.de')
Please login to merge, or discard this patch.
htdocs/okapi/services/caches/search/save.php 1 patch
Doc Comments   +2 added lines patch added patch discarded remove patch
@@ -24,6 +24,7 @@  discard block
 block discarded – undo
24 24
     /**
25 25
      * Get [set_id, date_created, expires] for the given params_hash
26 26
      * (or [null, null, null] if not found).
27
+     * @param string $params_hash
27 28
      */
28 29
     private static function find_param_set($params_hash, $ref_max_age)
29 30
     {
@@ -92,6 +93,7 @@  discard block
 block discarded – undo
92 93
     /**
93 94
      * Important: YOU HAVE TO make sure $tables and $where_conds don't contain
94 95
      * unescaped user-supplied data!
96
+     * @param string[] $tables
95 97
      */
96 98
     public static function get_set($tables, $joins, $where_conds, $min_store, $ref_max_age)
97 99
     {
Please login to merge, or discard this patch.
htdocs/okapi/services/logs/images/add.php 1 patch
Doc Comments   +4 added lines patch added patch discarded remove patch
@@ -284,6 +284,10 @@
 block discarded – undo
284 284
     }
285 285
 
286 286
 
287
+    /**
288
+     * @param string $image_uuid
289
+     * @param string $file_ext
290
+     */
287 291
     private static function db_insert_image(
288 292
         $consumer_key, $user_id,
289 293
         $log_internal_id, $image_uuid, $position, $caption, $is_spoiler, $file_ext)
Please login to merge, or discard this patch.
htdocs/okapi/services/logs/images/log_images_common.inc.php 1 patch
Doc Comments   +7 added lines patch added patch discarded remove patch
@@ -17,6 +17,9 @@  discard block
 block discarded – undo
17 17
 
18 18
 class LogImagesCommon
19 19
 {
20
+    /**
21
+     * @param OkapiRequest $request
22
+     */
20 23
     function validate_image_uuid($request)
21 24
     {
22 25
         $image_uuid = $request->get_parameter('image_uuid');
@@ -63,6 +66,9 @@  discard block
 block discarded – undo
63 66
     }
64 67
 
65 68
 
69
+    /**
70
+     * @param OkapiRequest $request
71
+     */
66 72
     function validate_position($request)
67 73
     {
68 74
         $position = $request->get_parameter('position');
@@ -87,6 +93,7 @@  discard block
 block discarded – undo
87 93
      *
88 94
      * This function is always called when adding images. When editing images,
89 95
      * it is called only for OCDE and if the position parameter was supplied.
96
+     * @param integer $end_offset
90 97
      */
91 98
 
92 99
     static function prepare_position($log_internal_id, $position, $end_offset)
Please login to merge, or discard this patch.
htdocs/okapi/services/logs/submit.php 1 patch
Doc Comments   +7 added lines patch added patch discarded remove patch
@@ -713,6 +713,9 @@  discard block
 block discarded – undo
713 713
         return Okapi::formatted_response($request, $result);
714 714
     }
715 715
 
716
+    /**
717
+     * @param integer $when
718
+     */
716 719
     private static function increment_cache_stats($cache_internal_id, $when, $logtype)
717 720
     {
718 721
         if (Settings::get('OC_BRANCH') == 'oc.de')
@@ -788,6 +791,10 @@  discard block
 block discarded – undo
788 791
         }
789 792
     }
790 793
 
794
+    /**
795
+     * @param integer $when
796
+     * @param integer $text_html
797
+     */
791 798
     private static function insert_log_row(
792 799
         $consumer_key, $cache_internal_id, $user_internal_id, $logtype, $when,
793 800
         $formatted_comment, $text_html, $needs_maintenance2
Please login to merge, or discard this patch.
htdocs/okapi/services/replicate/replicate_common.inc.php 1 patch
Doc Comments   +8 added lines patch added patch discarded remove patch
@@ -165,6 +165,7 @@  discard block
 block discarded – undo
165 165
      * well as long as only log entry fields are replicated which update
166 166
      * some cache_logs column when changed (by OKAPI or OC code). See
167 167
      * https://github.com/opencaching/okapi/issues/382 for further discussion.
168
+     * @param string[] $geocache_ignored_fields
168 169
      */
169 170
     public static function verify_clog_consistency(
170 171
         $force_all=false, $geocache_ignored_fields = null
@@ -269,6 +270,13 @@  discard block
 block discarded – undo
269 270
      * In normal mode, update the changelog and don't return anything.
270 271
      * In fulldump mode, return the generated changelog entries *instead* of
271 272
      * updating it.
273
+     * @param string $feeder_method
274
+     * @param string $object_type
275
+     * @param string $feeder_keys_param
276
+     * @param string $key_name
277
+     * @param string $fields
278
+     * @param boolean $fulldump_mode
279
+     * @param boolean $use_cache
272 280
      */
273 281
     private static function generate_changelog_entries($feeder_method, $object_type, $feeder_keys_param,
274 282
         $key_name, $key_values, $fields, $fulldump_mode, $use_cache, $cache_timeout = 86400)
Please login to merge, or discard this patch.
htdocs/okapi/views/devel/comparator.inc.php 1 patch
Doc Comments   +4 added lines, -2 removed lines patch added patch discarded remove patch
@@ -215,6 +215,7 @@  discard block
 block discarded – undo
215 215
     * Makes comparison of the given database structures, support some options
216 216
     * @access private
217 217
     * @param string $source and $dest are strings - database tables structures
218
+    * @param string $dest
218 219
     * @return array
219 220
     * - table (array)
220 221
     *       - destOrphan (boolean)
@@ -376,8 +377,8 @@  discard block
 block discarded – undo
376 377
     /**
377 378
     * returns array of fields or keys definitions that differs in the given tables structure
378 379
     * @access private
379
-    * @param sring $sourceSql table structure
380
-    * @param sring $destSql right table structure
380
+    * @param string $sourceSql table structure
381
+    * @param string $destSql right table structure
381 382
     * supports some $options
382 383
     * @return array
383 384
     *   - [0]
@@ -734,6 +735,7 @@  discard block
 block discarded – undo
734 735
     /**
735 736
     * works the same as getDelimPos except returns position of the first occurence of the delimiter starting from
736 737
     * the end of the string
738
+    * @param string $string
737 739
     */
738 740
     function getDelimRpos($string, $offset=0, $delim=';', $skipInBrackets=false)
739 741
     {
Please login to merge, or discard this patch.
htdocs/okapi/views/update.php 1 patch
Doc Comments   +2 added lines patch added patch discarded remove patch
@@ -150,6 +150,8 @@
 block discarded – undo
150 150
      * Return the list of email addresses of developers who used any of the given
151 151
      * method names at least once. If $days is not null, then only consumers which
152 152
      * used the method in last X $days will be returned.
153
+     * @param string[] $service_names
154
+     * @param integer $days
153 155
      */
154 156
     public static function get_consumers_of($service_names, $days = null)
155 157
     {
Please login to merge, or discard this patch.