Curl step: Expose fields from response to use in next steps.

Author: sumaiyamannan

classes/local/step/curl_trait.php

@@ -81,6 +81,7 @@ public static function form_define_fields(): array {
             'rawpostdata' => ['type' => PARAM_RAW],
             'sideeffects' => ['type' => PARAM_RAW],
             'timeout' => ['type' => PARAM_INT],
+            'counterfield' => ['type' => PARAM_TEXT],
         ];
     }
 
@@ -156,6 +157,10 @@ public function form_add_custom_inputs(\MoodleQuickForm &$mform) {
 
         $mform->addElement('text', 'config_timeout', get_string('connector_curl:timeout', 'tool_dataflows'));
         $mform->addHelpButton('config_timeout', 'connector_curl:timeout', 'tool_dataflows');
+        
+        // Counter field.
+        $mform->addElement('text', 'config_counterfield', get_string('connector_curl:counterfield', 'tool_dataflows'));
+        $mform->addElement('static', 'config_counterfield_help', '', get_string('connector_curl:counterfield_help', 'tool_dataflows'));        
     }
 
     /**
@@ -302,6 +307,23 @@ public function execute($input = null) {
         if (!empty($file)) {
             fclose($file);
         }
+        
+        if (!empty($config->counterfield)) {
+            $counterfield = $config->counterfield;
+            $varresult = json_decode($result);
+            foreach ($varresult as $key => $value) {
+                $name = "{$counterfield}.{$key}";
+                if ($variables->evaluate($name)) {
+                    $variables->set($name, $value);
+                    $this->stepdef->set_config_by_name($name, $value);
+                    if (!$this->is_dry_run()) {
+                        $this->stepdef->save();
+                    }
+                } else {
+                    debugging($name . ': variable could not be evaluated', DEBUG_DEVELOPER);
+                }
+            }
+        }        
 
         $info = $curl->get_info();
         // Stores response to be reusable by other steps.
@@ -315,8 +337,6 @@ public function execute($input = null) {
             throw new \moodle_exception($httpcode . ':' . $result);
         }
 
-        // TODO: It would be good to define and list any fixed but exposed
-        // fields which the user can use and map to on the edit page.
         $variables->set('response', (object) [
             'result' => $result,
             'info' => (object) $info,

lang/en/tool_dataflows.php

@@ -492,6 +492,9 @@
 $string['connector_curl:output_response_result'] = 'Returns a string that contains the response to the request as text, or null if the request was unsuccessful or has not yet been sent.';
 $string['connector_curl:header_format'] = '<header>:<value>';
 $string['connector_curl:headers_invalid'] = 'Curl connector headers are invalid.';
+$string['connector_curl:counterfield'] = 'Counter field';
+$string['connector_curl:counterfield_help'] = 'Field used to iterates value from a curl request, if the data is not nested otherwise using json_reader for it. \n
+Example: access_token: ${{ record.access_token }}  ';
 
 // GPG.
 $string['gpg:userid'] = 'Key owner (user ID)';