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

src/Exception/MissingSurveySummaryException.php

@@ -0,0 +1,31 @@
+<?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\Exception;
+
+/**
+ * An exception used when survey's summary is missing
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class MissingSurveySummaryException extends \Exception
+{
+    /**
+     * Class constructor
+     *
+     * @param int $surveyId ID of survey
+     */
+    public function __construct($surveyId)
+    {
+        $template = 'Summary of survey with ID %d is missing. Does the survey exist?';
+        $message = sprintf($template, $surveyId);
+
+        parent::__construct($message);
+    }
+}

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;

src/Service/ParticipantService.php

@@ -8,14 +8,12 @@
 
 namespace Meritoo\LimeSurvey\ApiClient\Service;
 
-use Meritoo\Common\Collection\Collection;
 use Meritoo\LimeSurvey\ApiClient\Client\Client;
 use Meritoo\LimeSurvey\ApiClient\Exception\CannotProcessDataException;
 use Meritoo\LimeSurvey\ApiClient\Exception\MissingParticipantOfSurveyException;
 use Meritoo\LimeSurvey\ApiClient\Result\Collection\Participants;
 use Meritoo\LimeSurvey\ApiClient\Result\Collection\ParticipantsDetails;
 use Meritoo\LimeSurvey\ApiClient\Result\Item\Participant;
-use Meritoo\LimeSurvey\ApiClient\Result\Item\ParticipantShort;
 use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
 use Meritoo\LimeSurvey\ApiClient\Type\ReasonType;
 
@@ -34,14 +32,6 @@ class ParticipantService
      */
     private $client;
 
-    /**
-     * Collection of participants' short data.
-     * All participants grouped per survey.
-     *
-     * @var Participants
-     */
-    private $allParticipants;
-
     /**
      * Collection of participants' full data.
      * All participants grouped per survey.
@@ -54,26 +44,18 @@ class ParticipantService
      * Class constructor
      *
      * @param Client              $client               Client of the LimeSurvey's API
-     * @param Participants        $allParticipants      (optional) Collection of participants' short data. All participants
-     *                                                  grouped per survey.
      * @param ParticipantsDetails $participantsDetails  (optional) Collection of participants' full data. All
      *                                                  participants grouped per survey.
      */
     public function __construct(
         Client $client,
-        Participants $allParticipants = null,
         ParticipantsDetails $participantsDetails = null
     ) {
-        if (null === $allParticipants) {
-            $allParticipants = new Participants();
-        }
-
         if (null === $participantsDetails) {
             $participantsDetails = new ParticipantsDetails();
         }
 
         $this->client = $client;
-        $this->allParticipants = $allParticipants;
         $this->participantsDetails = $participantsDetails;
     }
 
@@ -87,51 +69,6 @@ class ParticipantService
         return $this->client;
     }
 
-    /**
-     * Returns participants of given survey
-     *
-     * @param int $surveyId ID of survey
-     * @return Collection
-     *
-     * @throws CannotProcessDataException
-     */
-    public function getSurveyParticipants($surveyId)
-    {
-        $hasSurvey = $this
-            ->allParticipants
-            ->hasParticipantsOfSurvey($surveyId);
-
-        if (!$hasSurvey) {
-            $arguments = [
-                $surveyId,
-            ];
-
-            try {
-                $participants = $this
-                    ->client
-                    ->run(MethodType::LIST_PARTICIPANTS, $arguments)
-                    ->getData();
-            } catch (CannotProcessDataException $exception) {
-                /*
-                 * Oops, something is broken, because the reason is different than "there are no participants"
-                 */
-                if (ReasonType::NO_PARTICIPANTS_FOUND !== $exception->getReason()) {
-                    throw $exception;
-                }
-
-                $participants = new Collection();
-            }
-
-            $this
-                ->allParticipants
-                ->addParticipants($participants, $surveyId);
-        }
-
-        return $this
-            ->allParticipants
-            ->getBySurvey($surveyId);
-    }
-
     /**
      * Returns information if given survey has participant with given e-mail
      *
@@ -144,71 +81,6 @@ class ParticipantService
         return null !== $this->getParticipantDetails($surveyId, $email);
     }
 
-    /**
-     * Adds participant with given data to survey with given ID
-     *
-     * @param int    $surveyId  ID of survey
-     * @param string $firstName First name of the participant to add
-     * @param string $lastName  Last ame of the participant to add
-     * @param string $email     E-mail address of the participant to add
-     * @return Participant
-     */
-    public function addParticipant($surveyId, $firstName, $lastName, $email)
-    {
-        $participantsData = [
-            [
-                'firstname' => $firstName,
-                'lastname'  => $lastName,
-                'email'     => $email,
-            ],
-        ];
-
-        $arguments = [
-            $surveyId,
-            $participantsData,
-        ];
-
-        $participantCollection = $this
-            ->client
-            ->run(MethodType::ADD_PARTICIPANTS, $arguments)
-            ->getData();
-
-        /* @var Participant $addedParticipant */
-        $addedParticipant = $participantCollection->getFirst();
-
-        $participants = new Collection([
-            ParticipantShort::fromParticipant($addedParticipant),
-        ]);
-
-        $this
-            ->allParticipants
-            ->addParticipants($participants, $surveyId);
-
-        return $participantCollection->getFirst();
-    }
-
-    /**
-     * Returns short data of one participant with given e-mail (participant of given survey)
-     *
-     * @param int    $surveyId ID of survey
-     * @param string $email    E-mail address of the participant
-     * @return ParticipantShort|null
-     */
-    public function getParticipant($surveyId, $email)
-    {
-        /*
-         * I have to get all participants of survey to avoid problem when participants exist but are not loaded
-         */
-        $this->getSurveyParticipants($surveyId);
-
-        $participant = $this
-            ->allParticipants
-            ->getParticipantOfSurvey($surveyId, $email);
-
-        /* @var ParticipantShort $participant */
-        return $participant;
-    }
-
     /**
      * Returns full data of participant with given e-mail (participant of given survey)
      *

src/Service/SurveyService.php

@@ -11,14 +11,19 @@ namespace Meritoo\LimeSurvey\ApiClient\Service;
 use Meritoo\Common\Collection\Collection;
 use Meritoo\LimeSurvey\ApiClient\Client\Client;
 use Meritoo\LimeSurvey\ApiClient\Exception\CannotProcessDataException;
+use Meritoo\LimeSurvey\ApiClient\Exception\MissingSurveySummaryException;
+use Meritoo\LimeSurvey\ApiClient\Result\Collection\Participants;
 use Meritoo\LimeSurvey\ApiClient\Result\Collection\Surveys;
+use Meritoo\LimeSurvey\ApiClient\Result\Collection\SurveysSummaries;
 use Meritoo\LimeSurvey\ApiClient\Result\Item\Participant;
+use Meritoo\LimeSurvey\ApiClient\Result\Item\ParticipantShort;
 use Meritoo\LimeSurvey\ApiClient\Result\Item\Survey;
+use Meritoo\LimeSurvey\ApiClient\Result\Item\SurveySummary;
 use Meritoo\LimeSurvey\ApiClient\Type\MethodType;
 use Meritoo\LimeSurvey\ApiClient\Type\ReasonType;
 
 /**
- * Service that serves surveys
+ * Service that serves surveys and participants of surveys
  *
  * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
  * @copyright Meritoo.pl
@@ -40,6 +45,21 @@ class SurveyService
      */
     private $allSurveys;
 
+    /**
+     * Collection of participants' short data.
+     * All participants grouped per survey.
+     *
+     * @var Participants
+     */
+    private $allParticipants;
+
+    /**
+     * Collection of surveys' summaries (the SurveySummary class instances)
+     *
+     * @var SurveysSummaries
+     */
+    private $surveySummaries;
+
     /**
      * Template of the url used to start survey
      *
@@ -56,17 +76,36 @@ class SurveyService
     /**
      * Class constructor
      *
-     * @param Client  $client     Client of the LimeSurvey's API
-     * @param Surveys $allSurveys (optional) All surveys. Collection of surveys (the Survey class instances).
+     * @param Client           $client           Client of the LimeSurvey's API
+     * @param Surveys          $allSurveys       (optional) All surveys. Collection of surveys (the Survey class
+     *                                           instances).
+     * @param Participants     $allParticipants  (optional) Collection of participants' short data. All participants
+     *                                           grouped per survey.
+     * @param SurveysSummaries $surveysSummaries (optional) Collection of surveys' summaries (the SurveySummary class
+     *                                           instances)
      */
-    public function __construct(Client $client, Surveys $allSurveys = null)
-    {
+    public function __construct(
+        Client $client,
+        Surveys $allSurveys = null,
+        Participants $allParticipants = null,
+        SurveysSummaries $surveysSummaries = null
+    ) {
         if (null === $allSurveys) {
             $allSurveys = new Surveys();
         }
 
+        if (null === $allParticipants) {
+            $allParticipants = new Participants();
+        }
+
+        if (null === $surveysSummaries) {
+            $surveysSummaries = new SurveysSummaries();
+        }
+
         $this->client = $client;
         $this->allSurveys = $allSurveys;
+        $this->allParticipants = $allParticipants;
+        $this->surveySummaries = $surveysSummaries;
     }
 
     /**
@@ -82,7 +121,8 @@ class SurveyService
     /**
      * Returns all surveys
      *
-     * @param bool $onlyActive (optional) If is set to true, active surveys are returned only. Otherwise - all.
+     * @param bool $onlyActive (optional) If is set to true, active surveys are returned only. Otherwise - all (default
+     *                         behaviour).
      * @return Surveys
      *
      * @throws CannotProcessDataException
@@ -122,7 +162,7 @@ class SurveyService
      *
      * @param int  $surveyId       ID of survey to verify
      * @param bool $shouldBeActive (optional) If is set to true, survey should be active. If it's not, it shouldn't
-     *                             be returned, even if exists. Otherwise - it doesn't matter.
+     *                             be returned, even if exists. Otherwise - it doesn't matter (default behaviour).
      * @return bool
      */
     public function isExistingSurvey($surveyId, $shouldBeActive = false)
@@ -165,4 +205,182 @@ class SurveyService
 
         return sprintf($this->startSurveyUrlTemplate, $baseUrl, $surveyId, $participant->getToken());
     }
+
+    /**
+     * Returns participants of given survey
+     *
+     * @param int  $surveyId      ID of survey
+     * @param bool $onlyCompleted (optional) If is set to true, participants who completed survey are returned only.
+     *                            Otherwise - all (default behaviour).
+     * @return Collection
+     *
+     * @throws CannotProcessDataException
+     */
+    public function getSurveyParticipants($surveyId, $onlyCompleted = false)
+    {
+        $hasSurvey = $this
+            ->allParticipants
+            ->hasParticipantsOfSurvey($surveyId);
+
+        if (!$hasSurvey) {
+            $offset = 0;
+            $limit = $this->getSurveyTokenCount($surveyId);
+            $includeUnused = !$onlyCompleted;
+
+            $arguments = [
+                $surveyId,
+                $offset,
+                $limit,
+                $includeUnused,
+            ];
+
+            try {
+                $participants = $this
+                    ->client
+                    ->run(MethodType::LIST_PARTICIPANTS, $arguments)
+                    ->getData();
+            } catch (CannotProcessDataException $exception) {
+                /*
+                 * Oops, something is broken, because the reason is different than "there are no participants"
+                 */
+                if (ReasonType::NO_PARTICIPANTS_FOUND !== $exception->getReason()) {
+                    throw $exception;
+                }
+
+                $participants = new Collection();
+            }
+
+            $this
+                ->allParticipants
+                ->addParticipants($participants, $surveyId);
+        }
+
+        return $this
+            ->allParticipants
+            ->getBySurvey($surveyId);
+    }
+
+    /**
+     * Adds participant with given data to survey with given ID
+     *
+     * @param int    $surveyId  ID of survey
+     * @param string $firstName First name of the participant to add
+     * @param string $lastName  Last ame of the participant to add
+     * @param string $email     E-mail address of the participant to add
+     * @return Participant
+     */
+    public function addParticipant($surveyId, $firstName, $lastName, $email)
+    {
+        $participantsData = [
+            [
+                'firstname' => $firstName,
+                'lastname'  => $lastName,
+                'email'     => $email,
+            ],
+        ];
+
+        $arguments = [
+            $surveyId,
+            $participantsData,
+        ];
+
+        $participantCollection = $this
+            ->client
+            ->run(MethodType::ADD_PARTICIPANTS, $arguments)
+            ->getData();
+
+        /* @var Participant $addedParticipant */
+        $addedParticipant = $participantCollection->getFirst();
+
+        $participants = new Collection([
+            ParticipantShort::fromParticipant($addedParticipant),
+        ]);
+
+        $this
+            ->allParticipants
+            ->addParticipants($participants, $surveyId);
+
+        return $participantCollection->getFirst();
+    }
+
+    /**
+     * Returns short data of one participant with given e-mail (participant of given survey)
+     *
+     * @param int    $surveyId ID of survey
+     * @param string $email    E-mail address of the participant
+     * @return ParticipantShort|null
+     */
+    public function getParticipant($surveyId, $email)
+    {
+        /*
+         * I have to get all participants of survey to avoid problem when participants exist but are not loaded
+         */
+        $this->getSurveyParticipants($surveyId);
+
+        $participant = $this
+            ->allParticipants
+            ->getParticipantOfSurvey($surveyId, $email);
+
+        /* @var ParticipantShort $participant */
+        return $participant;
+    }
+
+    /**
+     * Returns count/amount of tokens of survey with given ID
+     *
+     * @param int $surveyId ID of survey
+     * @return int
+     *
+     * @throws MissingSurveySummaryException
+     */
+    public function getSurveyTokenCount($surveyId)
+    {
+        $surveySummary = $this
+            ->surveySummaries
+            ->getSurveySummary($surveyId);
+
+        /*
+         * Unknown survey's summary?
+         * Let's fetch it
+         */
+        if (null === $surveySummary) {
+            $surveySummary = $this->getSurveySummary($surveyId);
+        }
+
+        /*
+         * Oops, survey's summary is missing
+         */
+        if (null === $surveySummary) {
+            throw new MissingSurveySummaryException($surveyId);
+        }
+
+        return $surveySummary->getTokenCount();
+    }
+
+    /**
+     * Returns summary of survey with given ID
+     *
+     * @param int $surveyId ID of survey
+     * @return SurveySummary|null
+     */
+    private function getSurveySummary($surveyId)
+    {
+        $arguments = [
+            $surveyId,
+        ];
+
+        /* @var SurveySummary $surveySummary */
+        $surveySummary = $this
+            ->client
+            ->run(MethodType::GET_SUMMARY, $arguments)
+            ->getData();
+
+        if (null !== $surveySummary) {
+            $this
+                ->surveySummaries
+                ->addSurveySummary($surveySummary, $surveyId);
+        }
+
+        return $surveySummary;
+    }
 }

src/Type/MethodType.php

@@ -58,6 +58,13 @@ class MethodType extends BaseType
      */
     const GET_QUESTION_PROPERTIES = 'get_question_properties';
 
+    /**
+     * Get survey summary, regarding token usage and survey participation
+     *
+     * @var string
+     */
+    const GET_SUMMARY = 'get_summary';
+
     /**
      * Return the IDs and properties of token/participants of a survey
      *