Merge pull request #15 from statikbe/too-long-idx-name

Update create_unique_surveyhero_id_indices.php
statikbe · Apr 8, 2024 · 8ea9ac8 · 8ea9ac8
2 parents 818949e + 8943765
commit 8ea9ac8
Show file tree

Hide file tree

Showing 35 changed files with 36 additions and 193 deletions.
diff --git a/database/migrations/create_unique_surveyhero_id_indices.php b/database/migrations/create_unique_surveyhero_id_indices.php
@@ -27,7 +27,8 @@ public function up()
         });
 
         Schema::table($tableNames['survey_question_responses']['name'], function (Blueprint $table) {
-            $table->unique(['survey_response_id', 'survey_question_id', 'survey_answer_id']);
+            $table->unique(['survey_response_id', 'survey_question_id', 'survey_answer_id'])
+                ->name('survey_question_responses_ternary_ids_idx'); //for some dbs the id name generated by laravel is too long
         });
     }
 }
diff --git a/src/Commands/SurveyheroMapperCommand.php b/src/Commands/SurveyheroMapperCommand.php
@@ -16,9 +16,6 @@ class SurveyheroMapperCommand extends Command
 
     public $description = 'Map all questions and answers linked to configured surveys.';
 
-    /**
-     * @var \Statikbe\Surveyhero\Services\SurveyMappingService
-     */
     private SurveyMappingService $mappingService;
 
     public function __construct(SurveyMappingService $surveyMappingService)

diff --git a/src/Commands/SurveyheroResponseImportCommand.php b/src/Commands/SurveyheroResponseImportCommand.php
@@ -17,9 +17,6 @@ class SurveyheroResponseImportCommand extends Command
 
     public $description = 'Retrieve survey responses from SurveyHero API and save in the database.';
 
-    /**
-     * @var \Statikbe\Surveyhero\Services\SurveyResponseImportService
-     */
     private SurveyResponseImportService $importService;
 
     public function __construct(SurveyResponseImportService $surveyResponseImportService)

diff --git a/src/Commands/SurveyheroSurveyImportCommand.php b/src/Commands/SurveyheroSurveyImportCommand.php
@@ -14,9 +14,6 @@ class SurveyheroSurveyImportCommand extends Command
 
     public $description = 'Retrieve surveys from SurveyHero API and save in the database.';
 
-    /**
-     * @var \Statikbe\Surveyhero\Services\SurveyImportService
-     */
     private SurveyImportService $importService;
 
     public function __construct(SurveyImportService $surveyImportService)

diff --git a/src/Commands/SurveyheroWebhookAddCommand.php b/src/Commands/SurveyheroWebhookAddCommand.php
@@ -16,9 +16,6 @@ class SurveyheroWebhookAddCommand extends Command
 
     public $description = 'Automatically generate webhooks for survey responses on your desired URL.';
 
-    /**
-     * @var \Statikbe\Surveyhero\Services\SurveyWebhookService
-     */
     private SurveyWebhookService $webhookService;
 
     public function __construct(SurveyWebhookService $webhookService)

diff --git a/src/Commands/SurveyheroWebhookDeleteCommand.php b/src/Commands/SurveyheroWebhookDeleteCommand.php
@@ -15,9 +15,6 @@ class SurveyheroWebhookDeleteCommand extends Command
 
     public $description = 'Delete Surveyhero webhooks';
 
-    /**
-     * @var \Statikbe\Surveyhero\Services\SurveyWebhookService
-     */
     private SurveyWebhookService $webhookService;
 
     public function __construct(SurveyWebhookService $webhookService)

diff --git a/src/Commands/SurveyheroWebhookListCommand.php b/src/Commands/SurveyheroWebhookListCommand.php
@@ -14,9 +14,6 @@ class SurveyheroWebhookListCommand extends Command
 
     public $description = 'List webhooks for Surveyhero surveys';
 
-    /**
-     * @var \Statikbe\Surveyhero\Services\SurveyWebhookService
-     */
     private SurveyWebhookService $webhookService;
 
     public function __construct(SurveyWebhookService $webhookService)
@@ -42,7 +39,7 @@ public function handle(): int
             try {
                 $webhooks = $this->webhookService->listWebhooks($survey);
                 $webhookData = [];
-                foreach($webhooks as $webhook) {
+                foreach ($webhooks as $webhook) {
                     $webhookData[] = [
                         $webhook->webhook_id,
                         $webhook->event_type,
@@ -52,7 +49,7 @@ public function handle(): int
                     ];
                 }
                 $this->table(
-                    ['Webhook id','Event type','Url','Status','Created'],
+                    ['Webhook id', 'Event type', 'Url', 'Status', 'Created'],
                     $webhookData
                 );
             } catch (\Exception $e) {

diff --git a/src/Contracts/ModelContract.php b/src/Contracts/ModelContract.php
@@ -25,8 +25,6 @@ public function delete();
 
     /**
      * Returns the table name of the model.
-     *
-     * @return string
      */
     public function getTable(): string;
 }
diff --git a/src/Contracts/SurveyAnswerContract.php b/src/Contracts/SurveyAnswerContract.php
@@ -23,11 +23,6 @@ public function surveyQuestion(): BelongsTo;
 
     /**
      * Translate a variable with $key to $locale
-     *
-     * @param  string  $key
-     * @param  string  $locale
-     * @param  bool  $useFallbackLocale
-     * @return mixed
      */
     public function translate(string $key, string $locale = '', bool $useFallbackLocale = true): mixed;
 }
diff --git a/src/Contracts/SurveyContract.php b/src/Contracts/SurveyContract.php
@@ -32,9 +32,6 @@ public function getCollectors(): array;
 
     /**
      * Checks if the response timestamp is more recent than the last updated survey timestamp.
-     *
-     * @param  string  $responseLastUpdatedIsoTimestamp
-     * @return bool
      */
     public function doesResponseNeedsToBeUpdated(string $responseLastUpdatedIsoTimestamp): bool;
 }
diff --git a/src/Contracts/SurveyQuestionContract.php b/src/Contracts/SurveyQuestionContract.php
@@ -21,11 +21,6 @@ public function surveyAnswers(): HasMany;
 
     /**
      * Translate a variable with $key to $locale
-     *
-     * @param  string  $key
-     * @param  string  $locale
-     * @param  bool  $useFallbackLocale
-     * @return mixed
      */
     public function translate(string $key, string $locale = '', bool $useFallbackLocale = true): mixed;
 }
diff --git a/src/Exports/Sheets/AnswersSheet.php b/src/Exports/Sheets/AnswersSheet.php
@@ -12,7 +12,7 @@
 use Statikbe\Surveyhero\Contracts\SurveyContract;
 use Statikbe\Surveyhero\SurveyheroRegistrar;
 
-class AnswersSheet implements FromQuery, WithTitle, WithHeadings, WithMapping, ShouldAutoSize
+class AnswersSheet implements FromQuery, ShouldAutoSize, WithHeadings, WithMapping, WithTitle
 {
     private SurveyContract $survey;
 
@@ -73,7 +73,6 @@ public function headings(): array
 
     /**
      * @param  SurveyAnswerContract  $surveyAnswer
-     * @return array
      */
     public function map($surveyAnswer): array
     {

diff --git a/src/Exports/Sheets/QuestionsSheet.php b/src/Exports/Sheets/QuestionsSheet.php
@@ -11,7 +11,7 @@
 use Statikbe\Surveyhero\Contracts\SurveyContract;
 use Statikbe\Surveyhero\Contracts\SurveyQuestionContract;
 
-class QuestionsSheet implements FromQuery, WithTitle, WithHeadings, WithMapping, ShouldAutoSize
+class QuestionsSheet implements FromQuery, ShouldAutoSize, WithHeadings, WithMapping, WithTitle
 {
     private SurveyContract $survey;
 
@@ -63,7 +63,6 @@ public function headings(): array
 
     /**
      * @param  SurveyQuestionContract  $surveyQuestion
-     * @return array
      */
     public function map($surveyQuestion): array
     {

diff --git a/src/Exports/Sheets/ResponsesSheet.php b/src/Exports/Sheets/ResponsesSheet.php
@@ -10,7 +10,7 @@
 use Maatwebsite\Excel\Concerns\WithTitle;
 use Statikbe\Surveyhero\Contracts\SurveyContract;
 
-class ResponsesSheet implements FromCollection, WithTitle, WithHeadings, ShouldAutoSize
+class ResponsesSheet implements FromCollection, ShouldAutoSize, WithHeadings, WithTitle
 {
     private SurveyContract $survey;
 

diff --git a/src/Exports/SurveyExport.php b/src/Exports/SurveyExport.php
@@ -10,7 +10,7 @@
 use Statikbe\Surveyhero\Exports\Sheets\QuestionsSheet;
 use Statikbe\Surveyhero\Exports\Sheets\ResponsesSheet;
 
-class SurveyExport implements WithMultipleSheets, ShouldAutoSize
+class SurveyExport implements ShouldAutoSize, WithMultipleSheets
 {
     use Exportable;
 
@@ -47,7 +47,6 @@ public function sheets(): array
      * Override default worksheets list.
      *
      * @param  array<object>  $sheets
-     * @return void
      */
     public function setSheets(array $sheets): void
     {

diff --git a/src/Http/SurveyheroClient.php b/src/Http/SurveyheroClient.php
@@ -46,15 +46,15 @@ public function getSurveyResponseAnswers(string|int $surveyId, string|int $respo
         return $answerData->successful() ? json_decode($answerData->body()) : null;
     }
 
-    public function getSurveyElements(string|int $surveyId, string $lang = null): array
+    public function getSurveyElements(string|int $surveyId, ?string $lang = null): array
     {
         $questionsData = $this->fetchFromSurveyHero(sprintf('surveys/%s/elements%s', $surveyId, $lang ? '?lang='.$lang : null));
         $questions = json_decode($questionsData->body());
 
         return $questions ? $questions->elements : [];
     }
 
-    public function getSurveyQuestions(string|int $surveyId, string $lang = null): array
+    public function getSurveyQuestions(string|int $surveyId, ?string $lang = null): array
     {
         $questionsData = $this->fetchFromSurveyHero(sprintf('surveys/%s/questions%s', $surveyId, $lang ? '?lang='.$lang : null));
         $questions = json_decode($questionsData->body());
@@ -120,8 +120,8 @@ private function fetchFromSurveyHero(string $urlPath, array $queryStringArgs = [
         $this->preventThrottle();
 
         $response = Http::retry(3, 800)
-                        ->withBasicAuth(config('surveyhero.api_username'), config('surveyhero.api_password'))
-                        ->get(config('surveyhero.api_url').$urlPath, $queryStringArgs);
+            ->withBasicAuth(config('surveyhero.api_username'), config('surveyhero.api_password'))
+            ->get(config('surveyhero.api_url').$urlPath, $queryStringArgs);
 
         $this->updateThrottle();
 
@@ -140,8 +140,8 @@ private function postToSurveyHero(string $urlPath, array $queryStringArgs = []):
         $this->preventThrottle();
 
         $response = Http::retry(3, 600)
-                        ->withBasicAuth(config('surveyhero.api_username'), config('surveyhero.api_password'))
-                        ->post(config('surveyhero.api_url').$urlPath, $queryStringArgs);
+            ->withBasicAuth(config('surveyhero.api_username'), config('surveyhero.api_password'))
+            ->post(config('surveyhero.api_url').$urlPath, $queryStringArgs);
 
         $this->updateThrottle();
 
@@ -160,8 +160,8 @@ private function deleteFromSurveyHero(string $urlPath, array $queryStringArgs =
         $this->preventThrottle();
 
         $response = Http::retry(3, 600)
-                        ->withBasicAuth(config('surveyhero.api_username'), config('surveyhero.api_password'))
-                        ->delete(config('surveyhero.api_url').$urlPath, $queryStringArgs);
+            ->withBasicAuth(config('surveyhero.api_username'), config('surveyhero.api_password'))
+            ->delete(config('surveyhero.api_url').$urlPath, $queryStringArgs);
 
         $this->updateThrottle();
 

diff --git a/src/Models/Survey.php b/src/Models/Survey.php
@@ -14,9 +14,9 @@
 
 class Survey extends Model implements SurveyContract
 {
+    use HasCollectors;
     use HasFactory;
     use HasQuestionMapping;
-    use HasCollectors;
 
     protected $guarded = [];
 

diff --git a/src/Services/AbstractSurveyheroAPIService.php b/src/Services/AbstractSurveyheroAPIService.php
@@ -6,9 +6,6 @@
 
 class AbstractSurveyheroAPIService
 {
-    /**
-     * @var \Statikbe\Surveyhero\Http\SurveyheroClient
-     */
     protected SurveyheroClient $client;
 
     public function __construct()

diff --git a/src/Services/Factories/QuestionAndAnswerCreator/AbstractQuestionAndAnswerCreator.php b/src/Services/Factories/QuestionAndAnswerCreator/AbstractQuestionAndAnswerCreator.php
@@ -12,13 +12,6 @@
 abstract class AbstractQuestionAndAnswerCreator implements QuestionAndAnswerCreator
 {
     /**
-     * @param  SurveyContract  $survey
-     * @param  string  $lang
-     * @param  string  $questionId
-     * @param  string|null  $label
-     * @param  string|null  $subquestionId
-     * @return SurveyQuestionContract
-     *
      * @throws \Statikbe\Surveyhero\Exceptions\QuestionNotMappedException
      * @throws \Statikbe\Surveyhero\Exceptions\SurveyNotMappedException
      */
@@ -57,11 +50,6 @@ protected function getChoiceMapping(string|int $choiceId, string|int $questionId
     }
 
     /**
-     * @param  mixed  $mappedChoice
-     * @param  string  $dataType
-     * @param  array  $responseData
-     * @param  \stdClass  $surveyheroChoice
-     *
      * @throws AnswerNotMappedException
      */
     protected function setChoiceAndConvertToDataType(mixed $mappedChoice,

diff --git a/src/Services/Factories/QuestionAndAnswerCreator/ChoiceListQuestionAndAnswerCreator.php b/src/Services/Factories/QuestionAndAnswerCreator/ChoiceListQuestionAndAnswerCreator.php
@@ -12,11 +12,6 @@ class ChoiceListQuestionAndAnswerCreator extends AbstractQuestionAndAnswerCreato
     const TYPE = 'choice_list';
 
     /**
-     * @param  \stdClass  $question
-     * @param  SurveyContract  $survey
-     * @param  string  $lang
-     * @return SurveyQuestionContract|array
-     *
      * @throws \Statikbe\Surveyhero\Exceptions\AnswerNotMappedException
      * @throws \Statikbe\Surveyhero\Exceptions\QuestionNotMappedException
      * @throws \Statikbe\Surveyhero\Exceptions\SurveyNotMappedException

diff --git a/src/Services/Factories/QuestionAndAnswerCreator/InputQuestionAndAnswerCreator.php b/src/Services/Factories/QuestionAndAnswerCreator/InputQuestionAndAnswerCreator.php
@@ -16,6 +16,7 @@ class InputQuestionAndAnswerCreator extends AbstractQuestionAndAnswerCreator
     public function updateOrCreateQuestionAndAnswer(\stdClass $question, SurveyContract $survey, string $lang): SurveyQuestionContract|array
     {
         $surveyQuestion = $this->updateOrCreateQuestion($survey, $lang, $question->element_id, $question->question->question_text);
+
         //the answer is different for each user entry, so we cannot save answers for this type of question.
         return $surveyQuestion;
     }

diff --git a/src/Services/Factories/QuestionAndAnswerCreator/QuestionAndAnswerCreator.php b/src/Services/Factories/QuestionAndAnswerCreator/QuestionAndAnswerCreator.php
@@ -9,11 +9,6 @@
 interface QuestionAndAnswerCreator
 {
     /**
-     * @param  \stdClass  $question
-     * @param  SurveyContract  $survey
-     * @param  string  $lang
-     * @return SurveyQuestionContract|array
-     *
      * @throws AnswerNotMappedException
      */
     public function updateOrCreateQuestionAndAnswer(\stdClass $question, SurveyContract $survey, string $lang): SurveyQuestionContract|array;

diff --git a/src/Services/Factories/QuestionMapper/AbstractQuestionMapper.php b/src/Services/Factories/QuestionMapper/AbstractQuestionMapper.php
@@ -5,10 +5,6 @@
 abstract class AbstractQuestionMapper implements QuestionMapper
 {
     /**
-     * @param  int  $questionId
-     * @param  string  $questionType
-     * @param  string  $mappedDataType
-     * @param  int|string  $questionFieldSuffix
      * @return array{'question_id': int, 'type': string, 'field': string, 'mapped_data_type': string }
      */
     public function createQuestionMap(int $questionId, string $questionType, string $mappedDataType, int|string $questionFieldSuffix): array