Package: questionnaire

Source: api/packages/questionnaire · imported version 0.2.26. The sections after the README are extracted from the code on every docs build.

README

Questionnaire package

What does it do

This package is used for creating Questionnaire for Ulams.

Installing

• composer require ulams/questionnaire
• php artisan migrate
• php artisan db:seed --class="Ulams\Questionnaire\Database\Seeders\QuestionnairePermissionsSeeder"

Endpoints

All the endpoints are defined in

Tests

Run ./vendor/bin/phpunit to run tests. See tests folder as it’s quite good staring point as documentation appendix.

Test details

Events

This package does not dispatch any events.

Listeners

This package does not listen for any events

How to use this on frontend.

Admin panel

Left menu

List of questionnaire

Creating/editing questionnaire

Creating/editing question

Assign questionnaire to Course

List of Answers

Report

Front Application

…

Permissions

Permissions are defined in seeder

Database relation

1. Questionnaires general Questionnaire (Title) is related to Questionnaire_models
2. Questionnaire_models Questionnaire model belong to model type and model id
3. Questionnaire_model_types Model Type (Curse, Webinar etc.)
4. Questions Question belong to Questionnaire
5. Question_answers Question answer is related to Question and Questionnaire_models

Questionnaires 1 -> n Questionnaire_models
Questionnaires 1 -> n Questions
Questionnaire_models 1 -> n Questionnaire_model_types
Question_answers 1 -> n Questions
Question_answers 1 -> n Questionnaire_models

To add new model type you need to insert new record to Questionnaire_model_types

title -> Title of model (example - 'Course')
model_class => Model class name (example 'Ulams\Courses\Models\Course')

More documentation in the package

• api/packages/questionnaire/ADMIN.md
• api/packages/questionnaire/docs/add_question.png
• api/packages/questionnaire/docs/answers.png
• api/packages/questionnaire/docs/assign_course.png
• api/packages/questionnaire/docs/list.png
• api/packages/questionnaire/docs/menu.png
• api/packages/questionnaire/docs/new_questionnairy.png
• api/packages/questionnaire/docs/report.png

API endpoints

Method	Path	Auth	Action
GET	/api/admin/questionnaire	yes	QuestionnaireAdminApiController@list
DELETE	/api/admin/questionnaire/unassign/{model_type_title}/{model_id}/{id}/{target_group?}	yes	QuestionnaireAdminApiController@unassign
PATCH	/api/admin/questionnaire/assign/{model_type_title}/{model_id}/{id}/{target_group?}	yes	QuestionnaireAdminApiController@assign
GET	/api/admin/questionnaire/{id}	yes	QuestionnaireAdminApiController@read
POST	/api/admin/questionnaire	yes	QuestionnaireAdminApiController@create
DELETE	/api/admin/questionnaire/{id}	yes	QuestionnaireAdminApiController@delete
PATCH	/api/admin/questionnaire/{id}	yes	QuestionnaireAdminApiController@update
GET	/api/admin/questionnaire/{model_type_title}/{model_id}/{id}/export	yes	QuestionnaireAdminApiController@exportReport
GET	/api/admin/questionnaire/report/{id}	yes	QuestionnaireAdminApiController@report
GET	/api/admin/questionnaire/report/{id}/{model_type_id}	yes	QuestionnaireAdminApiController@report
GET	/api/admin/questionnaire/report/{id}/{model_type_id}/{model_id}	yes	QuestionnaireAdminApiController@report
GET	/api/admin/questionnaire-models	yes	QuestionnaireAdminApiController@getModelsType
POST	/api/admin/question-answers/{id}/change-visibility	yes	QuestionAnswerAdminApiController@changeAnswerVisibility
GET	/api/admin/question-answers/{id}	yes	QuestionAnswerAdminApiController@list
GET	/api/admin/question	yes	QuestionAdminApiController@list
GET	/api/admin/question/{id}	yes	QuestionAdminApiController@read
POST	/api/admin/question	yes	QuestionAdminApiController@create
DELETE	/api/admin/question/{id}	yes	QuestionAdminApiController@delete
PATCH	/api/admin/question/{id}	yes	QuestionAdminApiController@update
GET	/api/questionnaire/stars/{model_type_title}/{model_id}		QuestionnaireApiController@stars
GET	/api/questionnaire/{model_type_title}/{model_id}		QuestionnaireApiController@list
GET	/api/questionnaire/{model_type_title}/{model_id}/{id}		QuestionnaireApiController@read
POST	/api/questionnaire/{model_type_title}/{model_id}/{id}		QuestionnaireApiController@answer
GET	/api/questionnaire/{model_type_title}/{model_id}/questions/{question_id}/answers		QuestionnaireApiController@questionModelAnswers
GET	/api/questionnaire/{model_type_title}/{model_id}/questions/{question_id}/stars		QuestionnaireApiController@modelStars

Permissions

Permission	Seeded for roles	Constant
questionnaire_list	admin, tutor	QuestionnairePermissionsEnum::QUESTIONNAIRE_LIST
questionnaire_read	admin, tutor	QuestionnairePermissionsEnum::QUESTIONNAIRE_READ
questionnaire_create	admin, tutor	QuestionnairePermissionsEnum::QUESTIONNAIRE_CREATE
questionnaire_delete	admin, tutor	QuestionnairePermissionsEnum::QUESTIONNAIRE_DELETE
questionnaire_update	admin, tutor	QuestionnairePermissionsEnum::QUESTIONNAIRE_UPDATE
question_list	admin, tutor	QuestionnairePermissionsEnum::QUESTION_LIST
question_read	admin, tutor	QuestionnairePermissionsEnum::QUESTION_READ
question_create	admin, tutor	QuestionnairePermissionsEnum::QUESTION_CREATE
question_delete	admin, tutor	QuestionnairePermissionsEnum::QUESTION_DELETE
question_update	admin, tutor	QuestionnairePermissionsEnum::QUESTION_UPDATE
question_answer_visibility_change	admin, tutor	QuestionnairePermissionsEnum::QUESTION_ANSWER_VISIBILITY_CHANGE
questionnaire_list_authored	tutor	QuestionnairePermissionsEnum::QUESTIONNAIRE_LIST_AUTHORED

Settings

Registered with AdministrableConfig::registerConfig (editable in the admin panel under Configuration → Settings).

Key	Rules	Public	Read-only
ulams_questionnaires.new_answers_visible_by_default	required, boolean	yes

Events

None.

Artisan commands

None.

Scheduled jobs

None.

Environment variables read

None.