Adding doc block

moodle · May 10, 2011 · 6c0235b · 6c0235b
1 parent e10e887
commit 6c0235b
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/backup/util/helper/convert_helper.class.php b/backup/util/helper/convert_helper.class.php
@@ -57,6 +57,16 @@ public static function obj_to_readable($obj) {
         return implode(", ", array_map($mapper, array_keys($fields), array_values($fields)));
     }
 
+    /**
+     * Generate an artificial context ID
+     *
+     * @static
+     * @throws Exception
+     * @param int $instance The moodle component instance ID, same value used for get_context_instance()
+     * @param string $component The moodle component, like block_html, mod_quiz, etc
+     * @param string $converterid The converter ID
+     * @return int
+     */
     public static function get_contextid($instance, $component = 'moodle', $converterid = NULL) {
         global $DB;