New feature #07687 : RemoteControl2 export_responses should also have…

… an Array / JSON with responses

application/helpers/admin/export/JsonWriter.php

@@ -0,0 +1,69 @@
+<?php
+class JsonWriter extends Writer
+{
+    private $output;
+    /**
+     * The open filehandle
+     */
+    private $file = null;
+    /**
+     * first don't need seperator
+     */
+    protected $havePrev = false;
+
+    function __construct()
+    {
+        $this->output = '';
+    }
+
+    public function init(SurveyObj $survey, $sLanguageCode, FormattingOptions $oOptions)
+    {
+        parent::init($survey, $sLanguageCode, $oOptions);
+        $sStartOutput='{'.json_encode("responses").': [';
+        if ($oOptions->output=='display') {
+            header("Content-type: application/json");
+            echo $sStartOutput;
+        } elseif ($oOptions->output == 'file') {
+            $this->file = fopen($this->filename, 'w');
+            fwrite($this->file, $sStartOutput);
+        }
+
+    }
+
+    protected function outputRecord($headers, $values, FormattingOptions $oOptions)
+    {
+        $aJson[$values[0]]=array_combine ($headers,$values);
+        $sJson=json_encode($aJson);
+        Yii::log($this->havePrev, 'info', 'info');
+        if($this->havePrev){
+            $sJson=','.$sJson;
+
+        }
+        $this->havePrev=true;
+        if ($oOptions->output=='display')
+        {
+            echo $sJson;
+            $this->output = '';
+        } elseif ($oOptions->output == 'file') {
+            $this->output .= $sJson;
+            fwrite($this->file, $this->output);
+            $this->output='';
+        }
+
+    }
+
+    public function close()
+    {
+        $sEndOutput=']}';
+        if (!$this->file)
+        {
+            echo $sEndOutput;
+        }
+        else
+        {
+            $this->output .= $sEndOutput;
+            fwrite($this->file, $this->output);
+            fclose($this->file);
+        }
+    }
+}

application/helpers/admin/exportresults_helper.php

@@ -85,7 +85,8 @@ function exportSurvey($iSurveyId, $sLanguageCode, $sExportPlugin, FormattingOpti
             'xls' => '',
             'pdf' => '',
             'html' => '',
-            'csv' => ''
+            'csv' => '',
+            'json' => ''
         );
         $event = new PluginEvent('listExportPlugins');
         $oPluginManager = App()->getPluginManager();
@@ -114,6 +115,9 @@ function exportSurvey($iSurveyId, $sLanguageCode, $sExportPlugin, FormattingOpti
                 case "html":
                     $writer = new HtmlWriter();
                     break;
+                case "json":
+                    $writer = new JsonWriter();
+                    break;
                 case "csv":
                 default:
                     $writer = new CsvWriter();
@@ -146,4 +150,4 @@ function exportSurvey($iSurveyId, $sLanguageCode, $sExportPlugin, FormattingOpti
             return $result;
         }
     }
-}
+}

application/helpers/remotecontrol/remotecontrol_handle.php

@@ -2192,7 +2192,7 @@ public function add_response($sSessionKey, $iSurveyID, $aResponseData)
      * @access public
      * @param string $sSessionKey Auth credentials
      * @param int $iSurveyID Id of the Survey
-     * @param string $sDocumentType pdf,csv,xls,doc
+     * @param string $sDocumentType pdf,csv,xls,doc,json
      * @param string $sLanguageCode The language to be used
      * @param string $sCompletionStatus Optional 'complete','incomplete' or 'all' - defaults to 'all'
      * @param string $sHeadingType 'code','full' or 'abbreviated' Optional defaults to 'code'
@@ -2202,7 +2202,7 @@ public function add_response($sSessionKey, $iSurveyID, $aResponseData)
      * @param array $aFields Optional Selected fields
      * @return array|string On success: Requested file as base 64-encoded string. On failure array with error information
      * */
-    public function export_responses($sSessionKey, $iSurveyID, $sDocumentType, $sLanguageCode=null, $sCompletionStatus='all', $sHeadingType='full', $sResponseType='short', $iFromResponseID=null, $iToResponseID=null, $aFields=null)
+    public function export_responses($sSessionKey, $iSurveyID, $sDocumentType, $sLanguageCode=null, $sCompletionStatus='all', $sHeadingType='code', $sResponseType='short', $iFromResponseID=null, $iToResponseID=null, $aFields=null)
     {
         if (!$this->_checkSessionKey($sSessionKey)) return array('status' => 'Invalid session key');
         Yii::app()->loadHelper('admin/exportresults');
@@ -2246,7 +2246,7 @@ public function export_responses($sSessionKey, $iSurveyID, $sDocumentType, $sLan
      * @access public
      * @param string $sSessionKey Auth credentials
      * @param int $iSurveyID Id of the Survey
-     * @param string $sDocumentType pdf,csv,xls,doc
+     * @param string $sDocumentType pdf,csv,xls,doc,json
      * @param string $sToken The token for which responses needed
      * @param string $sLanguageCode The language to be used
      * @param string $sCompletionStatus Optional 'complete','incomplete' or 'all' - defaults to 'all'
@@ -2256,7 +2256,7 @@ public function export_responses($sSessionKey, $iSurveyID, $sDocumentType, $sLan
      * @return array|string On success: Requested file as base 64-encoded string. On failure array with error information
      * 
      */
-    public function export_responses_by_token($sSessionKey, $iSurveyID, $sDocumentType, $sToken, $sLanguageCode=null, $sCompletionStatus='all', $sHeadingType='full', $sResponseType='short', $aFields=null)
+    public function export_responses_by_token($sSessionKey, $iSurveyID, $sDocumentType, $sToken, $sLanguageCode=null, $sCompletionStatus='all', $sHeadingType='code', $sResponseType='short', $aFields=null)
     {
         if (!$this->_checkSessionKey($sSessionKey)) return array('status' => 'Invalid session key');
         if (!Permission::model()->hasSurveyPermission($iSurveyID, 'responses', 'export')) return array('status' => 'No permission');
@@ -2340,4 +2340,4 @@ protected function _checkSessionKey($sSessionKey)
             return true;
         }
     }
-}
+}