Fetch all participants of survey (instead of first 10 only - default behaviour)

src/Result/Collection/SurveysSummaries.php

@@ -0,0 +1,116 @@
+<?php
+
+/**
+ * (c) Meritoo.pl, http://www.meritoo.pl
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Meritoo\LimeSurvey\ApiClient\Result\Collection;
+
+use Meritoo\Common\Collection\Collection;
+use Meritoo\Common\Exception\Method\DisabledMethodException;
+use Meritoo\LimeSurvey\ApiClient\Result\Item\SurveySummary;
+
+/**
+ * Collection of surveys' summaries (the SurveySummary class instances)
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class SurveysSummaries extends Collection
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function add($element, $index = null)
+    {
+        throw new DisabledMethodException(__METHOD__, 'addSurveySummary');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function addMultiple($elements, $useIndexes = false)
+    {
+        throw new DisabledMethodException(__METHOD__, 'addSurveysSummaries');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function has($element)
+    {
+        throw new DisabledMethodException(__METHOD__, 'hasSurveySummary');
+    }
+
+    /**
+     * Adds survey's summary
+     *
+     * @param SurveySummary $summary  Survey's summary
+     * @param int           $surveyId ID of survey
+     * @return $this
+     */
+    public function addSurveySummary(SurveySummary $summary, $surveyId)
+    {
+        $this[$surveyId] = $summary;
+
+        return $this;
+    }
+
+    /**
+     * Adds surveys' summaries
+     *
+     * @param array $summaries Surveys' summaries to add
+     * @return $this
+     */
+    public function addSurveysSummaries(array $summaries)
+    {
+        /*
+         * No summaries?
+         * Nothing to do
+         */
+        if (empty($summaries)) {
+            return $this;
+        }
+
+        foreach ($summaries as $surveyId => $summary) {
+            $this->addSurveySummary($summary, $surveyId);
+        }
+
+        return $this;
+    }
+
+    /**
+     * Returns information if there is summary of survey with given ID
+     *
+     * @param int $surveyId ID of survey
+     * @return bool
+     */
+    public function hasSurveySummary($surveyId)
+    {
+        /*
+         * There are no surveys' summaries or there is no summary of survey with given ID?
+         */
+        if ($this->isEmpty() || !isset($this[$surveyId])) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Returns summary of survey with given ID
+     *
+     * @param int $surveyId ID of survey
+     * @return SurveySummary|null
+     */
+    public function getSurveySummary($surveyId)
+    {
+        if ($this->hasSurveySummary($surveyId)) {
+            return $this[$surveyId];
+        }
+
+        return null;
+    }
+}

src/Result/Item/SurveySummary.php

@@ -0,0 +1,196 @@
+<?php
+
+/**
+ * (c) Meritoo.pl, http://www.meritoo.pl
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Meritoo\LimeSurvey\ApiClient\Result\Item;
+
+use Meritoo\LimeSurvey\ApiClient\Base\Result\BaseItem;
+
+/**
+ * One item of the result/data: survey's summary (contains aggregated data)
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class SurveySummary extends BaseItem
+{
+    /**
+     * Count/Amount of tokens
+     *
+     * @var int
+     */
+    private $tokenCount;
+
+    /**
+     * Count/Amount of invalid tokens
+     *
+     * @var int
+     */
+    private $tokenInvalidCount;
+
+    /**
+     * Count/Amount of sent tokens
+     *
+     * @var int
+     */
+    private $tokenSentCount;
+
+    /**
+     * Count/Amount of opted out tokens
+     *
+     * @var int
+     */
+    private $tokenOptedOutCount;
+
+    /**
+     * Count/Amount of completed tokens
+     *
+     * @var int
+     */
+    private $tokenCompletedCount;
+
+    /**
+     * Count/Amount of complete responses
+     *
+     * @var int
+     */
+    private $completeResponsesCount;
+
+    /**
+     * Count/Amount of incomplete responses
+     *
+     * @var int
+     */
+    private $incompleteResponsesCount;
+
+    /**
+     * Count/Amount of full responses
+     *
+     * @var int
+     */
+    private $fullResponsesCount;
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setValue($property, $value)
+    {
+        switch ($property) {
+            case 'token_count':
+                $this->tokenCount = (int)$value;
+                break;
+
+            case 'token_invalid':
+                $this->tokenInvalidCount = (int)$value;
+                break;
+
+            case 'token_sent':
+                $this->tokenSentCount = (int)$value;
+                break;
+
+            case 'token_opted_out':
+                $this->tokenOptedOutCount = (int)$value;
+                break;
+
+            case 'token_completed':
+                $this->tokenCompletedCount = (int)$value;
+                break;
+
+            case 'completed_responses':
+                $this->completeResponsesCount = (int)$value;
+                break;
+
+            case 'incomplete_responses':
+                $this->incompleteResponsesCount = (int)$value;
+                break;
+
+            case 'full_responses':
+                $this->fullResponsesCount = (int)$value;
+                break;
+        }
+    }
+
+    /**
+     * Returns count/amount of tokens
+     *
+     * @return int
+     */
+    public function getTokenCount()
+    {
+        return $this->tokenCount;
+    }
+
+    /**
+     * Returns count/amount of invalid tokens
+     *
+     * @return int
+     */
+    public function getTokenInvalidCount()
+    {
+        return $this->tokenInvalidCount;
+    }
+
+    /**
+     * Returns count/amount of sent tokens
+     *
+     * @return int
+     */
+    public function getTokenSentCount()
+    {
+        return $this->tokenSentCount;
+    }
+
+    /**
+     * Returns count/amount of opted out tokens
+     *
+     * @return int
+     */
+    public function getTokenOptedOutCount()
+    {
+        return $this->tokenOptedOutCount;
+    }
+
+    /**
+     * Returns count/amount of completed tokens
+     *
+     * @return int
+     */
+    public function getTokenCompletedCount()
+    {
+        return $this->tokenCompletedCount;
+    }
+
+    /**
+     * Returns count/amount of complete responses
+     *
+     * @return int
+     */
+    public function getCompleteResponsesCount()
+    {
+        return $this->completeResponsesCount;
+    }
+
+    /**
+     * Returns count/amount of incomplete responses
+     *
+     * @return int
+     */
+    public function getIncompleteResponsesCount()
+    {
+        return $this->incompleteResponsesCount;
+    }
+
+    /**
+     * Returns count/amount of full responses
+     *
+     * @return int
+     */
+    public function getFullResponsesCount()
+    {
+        return $this->fullResponsesCount;
+    }
+}

src/Result/Processor/ResultProcessor.php

@@ -17,6 +17,7 @@ use Meritoo\LimeSurvey\ApiClient\Result\Item\ParticipantShort;
 use Meritoo\LimeSurvey\ApiClient\Result\Item\Question;
 use Meritoo\LimeSurvey\ApiClient\Result\Item\QuestionShort;
 use Meritoo\LimeSurvey\ApiClient\Result\Item\Survey;
+use Meritoo\LimeSurvey\ApiClient\Result\Item\SurveySummary;
 use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
 
 /**
@@ -95,6 +96,10 @@ class ResultProcessor
                 $className = Question::class;
                 break;
 
+            case MethodType::GET_SUMMARY:
+                $className = SurveySummary::class;
+                break;
+
             case MethodType::LIST_PARTICIPANTS:
                 $className = ParticipantShort::class;
                 break;