PHPackages kik/laravel-quiz - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. kik/laravel-quiz ActiveLibrary[Utility & Helpers](/categories/utility) kik/laravel-quiz ================ Provides Quiz Functionality 01PHP Since Apr 29Pushed 3y agoCompare [ Source](https://github.com/Temian1/laravel-quizzes)[ Packagist](https://packagist.org/packages/kik/laravel-quiz)[ RSS](/packages/kik-laravel-quiz/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependenciesVersions (1)Used By (0) [![Laravel Quiz](https://user-images.githubusercontent.com/10380630/172400217-b9192a50-3227-4d30-8e00-7a301fe68ddc.png)](https://user-images.githubusercontent.com/10380630/172400217-b9192a50-3227-4d30-8e00-7a301fe68ddc.png) Laravel Quiz ============ [](#laravel-quiz) [![Latest Version on Packagist](https://camo.githubusercontent.com/b480f1635728f7eba4659d7eab33faa1b1beb45a4e607a4b44cd5eecc3919ec0/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f68617269736864757267612f6c61726176656c2d7175697a2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/harishdurga/laravel-quiz)[![Total Downloads](https://camo.githubusercontent.com/a7b8fb768f517a775e090ba4de5c64ec79010f853d592e05c8c994e750575929/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f68617269736864757267612f6c61726176656c2d7175697a2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/harishdurga/laravel-quiz)[![GitHub Actions](https://github.com/harishdurga/laravel-quiz/actions/workflows/main.yml/badge.svg)](https://github.com/harishdurga/laravel-quiz/actions/workflows/main.yml/badge.svg) With this package you can easily get quiz functionality into your Laravel project. Features -------- [](#features) - Add Topics to Questions, Quizzes and to other Topics - Supported Question Types: Multiple Choice,Single Choice, and Fill In The Blank - Add your own Question Types and define your own methods to handle them - Flexible Negative Marking Settings - Flexible Quiz with most of the useful settings (Ex: Total marks, Pass marks, Negative Marking, Duration, Valid between date, Description etc) - Any type of User of your application can be a Participant of a Quiz - Any type of User, and any number of Users of your application can be Authors (different roles) For a Quiz - Generate Random Quizzes (In progress) Installation ------------ [](#installation) You can install the package via composer: ``` composer require harishdurga/laravel-quiz ``` - Laravel Version: 9.X - PHP Version: 8.X Usage ----- [](#usage) ### Class Diagram [](#class-diagram) [![LaravelQuiz](https://user-images.githubusercontent.com/10380630/182762726-de5d4b61-af3c-4d0f-b25d-dad986ff5b6e.jpg)](https://user-images.githubusercontent.com/10380630/182762726-de5d4b61-af3c-4d0f-b25d-dad986ff5b6e.jpg) ### Publish Vendor Files (config, mingrations,seeder) [](#publish-vendor-files-config-mingrationsseeder) ``` php artisan vendor:publish --provider="Harishdurga\LaravelQuiz\LaravelQuizServiceProvider" ``` If you are updating the package, you may need to run the above command to publish the vendor files. But please take a backup of the config file. Also run the migration command to add new columns to the existing tables. ### Create Topic [](#create-topic) ``` $computer_science = Topic::create([ 'name' => 'Computer Science', 'slug' => 'computer-science', ]); ``` #### Create Sub Topics [](#create-sub-topics) ``` $algorithms = Topic::create([ 'name' => 'Algorithms', 'slug' => 'algorithms' ]); $computer_science->children()->save($algorithms); ``` ### Question Types [](#question-types) A seeder class `QuestionTypeSeeder ` will be published into the `database/seeders` folder. Run the following command to seed question types. ``` php artisan db:seed --class=\\Harishdurga\\LaravelQuiz\\Database\\Seeders\\QuestionTypeSeeder ``` Currently this package is configured to only handle the following type of questions - `multiple_choice_single_answer` - `multiple_choice_multiple_answer` - `fill_the_blank` Create a QuestionType: ``` QuestionType::create(['name'=>'select_all']); ``` ### User Defined Methods To Evaluate The Answer For Each Question Type [](#user-defined-methods-to-evaluate-the-answer-for-each-question-type) Though this package provides three question types you can easily change the method that is used to evaluate the answer. You can do this by updating the `get_score_for_question_type` property in config file. ``` 'get_score_for_question_type' => [ 1 => '\Harishdurga\LaravelQuiz\Models\QuizAttempt::get_score_for_type_1_question', 2 => '\Harishdurga\LaravelQuiz\Models\QuizAttempt::get_score_for_type_2_question', 3 => '\Harishdurga\LaravelQuiz\Models\QuizAttempt::get_score_for_type_3_question', 4 => 'Your custom method' ] ``` But your method has needs to have the following signature ``` /** * @param QuizAttemptAnswer[] $quizQuestionAnswers All the answers of the quiz question */ public static function get_score_for_type_3_question(QuizAttempt $quizAttempt, QuizQuestion $quizQuestion, array $quizQuestionAnswers, $data = null): float { // Your logic here } ``` If you need to pass any data to your method then you can pass it as the last `$data` parameter. When you call the `caclculate_score()` method of `QuizAttempt` then you can pass the data as the parameter. ### Create Question [](#create-question) ``` $question_one = Question::create([ 'name' => 'What is an algorithm?', 'question_type_id' => 1, 'is_active' => true, 'media_url'=>'url', 'media_type'=>'image' ]); ``` ### Fetch Questions Of A Question Type [](#fetch-questions-of-a-question-type) ``` $question_type->questions ``` ### Fetch only questions with an option (valid question) [](#fetch-only-questions-with-an-option-valid-question) ``` Question::hasOptions()->get() ``` ### Attach Topics To Question [](#attach-topics-to-question) ``` $question->topics()->attach([$computer_science->id, $algorithms->id]); ``` ### Question Option [](#question-option) ``` $question_two_option_one = QuestionOption::create([ 'question_id' => $question_two->id, 'name' => 'array', 'is_correct' => true, 'media_type'=>'image', 'media_url'=>'media url' ]); ``` ### Fetch Options Of A Question [](#fetch-options-of-a-question) ``` $question->options ``` ### Create Quiz [](#create-quiz) ``` $quiz = Quiz::create([ 'name' => 'Computer Science Quiz', 'description' => 'Test your knowledge of computer science', 'slug' => 'computer-science-quiz', 'time_between_attempts' => 0, //Time in seconds between each attempt 'total_marks' => 10, 'pass_marks' => 6, 'max_attempts' => 1, 'is_published' => 1, 'valid_from' => now(), 'valid_upto' => now()->addDay(5), 'media_url'=>'', 'media_type'=>'', 'negative_marking_settings'=>[ 'enable_negative_marks' => true, 'negative_marking_type' => 'fixed', 'negative_mark_value' => 0, ] ]); ``` ### Attach Topics To A Quiz [](#attach-topics-to-a-quiz) ``` $quiz->topics()->attach([$topic_one->id, $topic_two->id]); ``` ### Topicable [](#topicable) Topics can be attached to a quiz or a question. Questions can exist outside of the quiz context. For example you can create a question bank which you can filter based on the topics if attached. ### Negative Marking Settings [](#negative-marking-settings) By default negative marking is enabled for backward compatibility. You can disable it by setting the `enable_negative_marks` to false. Two types of negative marking are supported(`negative_marking_type`). `fixed` and `percentage`. Negative marking value defined at question level will be given precedence over the value defined at quiz level. If you want to set the negative marking value at quiz level, set the `negative_mark_value` to the value you want to set. If you want to set the negative marking value at question level, set the `negative_marks` of `QuizQuestion` to your desired value. No need to give a negative number instead the negative marks or percentage should be given in positive. ### Adding An Author(s) To A Quiz [](#adding-an-authors-to-a-quiz) ``` $admin = Author::create( ['name' => "John Doe"] ); $quiz = Quiz::factory()->make()->create([ 'name' => 'Sample Quiz', 'slug' => 'sample-quiz' ]); QuizAuthor::create([ 'quiz_id' => $quiz->id, 'author_id' => $admin->id, 'author_type' => get_class($admin), 'author_role' => 'admin', ]); $quiz->quizAuthors->first()->author; //Original User ``` Add `CanAuthorQuiz` trait to your model and you can get all the quizzes associated by calling the `quizzes` relation. You can give any author role you want and implement ACL as per your usecase. ### Add Question To Quiz [](#add-question-to-quiz) ``` $quiz_question = QuizQuestion::create([ 'quiz_id' => $quiz->id, 'question_id' => $question->id, 'marks' => 3, 'order' => 1, 'negative_marks'=>1, 'is_optional'=>false ]); ``` ### Fetch Quiz Questions [](#fetch-quiz-questions) ``` $quiz->questions ``` ### Attempt The Quiz [](#attempt-the-quiz) ``` $quiz_attempt = QuizAttempt::create([ 'quiz_id' => $quiz->id, 'participant_id' => $participant->id, 'participant_type' => get_class($participant) ]); ``` ### Get the Quiz Attempt Participant [](#get-the-quiz-attempt-participant) `MorphTo` relation. ``` $quiz_attempt->participant ``` ### Answer Quiz Attempt [](#answer-quiz-attempt) ``` QuizAttemptAnswer::create( [ 'quiz_attempt_id' => $quiz_attempt->id, 'quiz_question_id' => $quiz_question->id, 'question_option_id' => $question_option->id, ] ); ``` A `QuizAttemptAnswer` belongs to `QuizAttempt`,`QuizQuestion` and `QuestionOption` ### Get Quiz Attempt Score [](#get-quiz-attempt-score) ``` $quiz_attempt->calculate_score() ``` In case of no answer found for a quiz question which is not optional, a negative score will be applied if any. ### Get Correct Option Of A Question [](#get-correct-option-of-a-question) ``` $question->correct_options ``` Return a collection of `QuestionOption`. ``` public function correct_options(): Collection { return $this->options()->where('is_correct', 1)->get(); } ``` Please refer unit and features tests for more understanding. ### Validate A Quiz Question [](#validate-a-quiz-question) Instead of getting total score for the quiz attempt, you can use `QuizAttempt` model's `validate()` method. This method will return an array with a QuizQuestion model's `id` as the key for the assoc array that will be returned. **Example:** ``` $quizAttempt->validate($quizQuestion->id); //For a particular question $quizAttempt->validate(); //For all the questions in the quiz attempt $quizAttempt->validate($quizQuestion->id,$data); //$data can any type ``` ``` [ 1 => [ 'score' => 10, 'is_correct' => true, 'correct_answer' => ['One','Five','Seven'], 'user_answer' => ['Five','One','Seven'] ], 2 => [ 'score' => 0, 'is_correct' => false, 'correct_answer' => 'Hello There', 'user_answer' => 'Hello World' ] ] ``` To be able to render the user answer and correct answer for different types of question types other than the 3 types supported by the package, a new config option has been added. ``` 'render_answers_responses' => [ 1 => '\Harishdurga\LaravelQuiz\Models\QuizAttempt::renderQuestionType1Answers', 2 => '\Harishdurga\LaravelQuiz\Models\QuizAttempt::renderQuestionType2Answers', 3 => '\Harishdurga\LaravelQuiz\Models\QuizAttempt::renderQuestionType3Answers', ] ``` By keeping the question type id as the key, you can put the path to your custom function to handle the question type. This custom method will be called from inside the `validate()` method by passing the `QuizQuestion` object as the argument for your custom method as defined in the config. **Example:** ``` public static function renderQuestionType1Answers(QuizQuestion $quizQuestion,QuizAttempt $quizAttempt,mixed $data=null) { /** * @var Question $actualQuestion */ $actualQuestion = $quizQuestion->question; $answers = $quizQuestion->answers->where('quiz_attempt_id', $quizAttempt->id); $questionOptions = $actualQuestion->options; $correctAnswer = $actualQuestion->correct_options()->first()?->option; $givenAnswer = $answers->first()?->question_option_id; foreach ($questionOptions as $questionOption) { if ($questionOption->id == $givenAnswer) { $givenAnswer = $questionOption->option; break; } } return [$correctAnswer, $givenAnswer]; } ``` As shown in the example you customer method should return an array with two elements the first one being the correct answer and the second element being the user's answer for the question. And whatever the `$data` you send to the `validate()` will be sent to these custom methods so that you can send additional data for rendering the answers. ### Testing [](#testing) ``` composer test ``` ### Changelog [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. Contributing ------------ [](#contributing) Please see [CONTRIBUTING](CONTRIBUTING.md) for details. ### Security [](#security) If you discover any security related issues, please email instead of using the issue tracker. Credits ------- [](#credits) - [Harish Durga](https://github.com/harishdurga) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. Laravel Package Boilerplate --------------------------- [](#laravel-package-boilerplate) This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com). ### Health Score 13 — LowBetter than 1% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity1 Limited adoption so far Community9 Small or concentrated contributor base Maturity22 Early-stage or recently created project Bus Factor1 Top contributor holds 85.7% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/d5332b731e1d74292dd2514693df159822027cdea967e29ce79206d3e5d97d17?d=identicon)[Kikismedia](/maintainers/Kikismedia) --- Top Contributors [![harishdurga](https://avatars.githubusercontent.com/u/10380630?v=4)](https://github.com/harishdurga "harishdurga (72 commits)")[![ades4827](https://avatars.githubusercontent.com/u/27701869?v=4)](https://github.com/ades4827 "ades4827 (11 commits)")[![Temian1](https://avatars.githubusercontent.com/u/39234980?v=4)](https://github.com/Temian1 "Temian1 (1 commits)") ### Embed Badge ![Health badge](/badges/kik-laravel-quiz/health.svg) ``` [![Health](https://phpackages.com/badges/kik-laravel-quiz/health.svg)](https://phpackages.com/packages/kik-laravel-quiz) ``` ### Alternatives [php-units-of-measure/php-units-of-measure A PHP library for converting between standard units of measure. 3123.4M20](/packages/php-units-of-measure-php-units-of-measure)[coderello/laravel-shared-data Package for sharing data from Laravel to JavaScript. 31377.3k1](/packages/coderello-laravel-shared-data) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)