bristol-su / static-page

app/CompletionConditions/HasViewedPage.php

<?php

Missing file doc comment

namespace BristolSU\Module\StaticPage\CompletionConditions;


use BristolSU\Module\StaticPage\Models\PageView;
use BristolSU\Support\ActivityInstance\ActivityInstance;
use BristolSU\Support\Completion\Contracts\CompletionCondition;
use BristolSU\Support\ModuleInstance\Contracts\ModuleInstance;
use FormSchema\Schema\Form;

class HasViewedPage extends CompletionCondition

Missing doc comment for class HasViewedPage

{

    /**
     * Is the condition fully complete?
     *
     * @param array $settings Settings of the completion condition

Expected 12 spaces after parameter type; 1 found

Expected 9 spaces after parameter name; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param ActivityInstance $activityInstance Activity instance to test

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param ModuleInstance $moduleInstance Module instance to test

Expected 3 spaces after parameter type; 1 found

Expected 3 spaces after parameter name; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return bool If the condition is complete

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function isComplete($settings, ActivityInstance $activityInstance, ModuleInstance $moduleInstance): bool
    {
        return PageView::forResource($activityInstance->id, $moduleInstance->id)->count() >= ( $settings['number_of_views'] ?? 1);

Accessing id on the interface BristolSU\Support\ModuleInstance\Contracts\ModuleInstance suggest that you code against a concrete implementation. How about adding an instanceof check?

    }

    public function percentage($settings, ActivityInstance $activityInstance, ModuleInstance $moduleInstance): int

Missing doc comment for function percentage()

    {
        $count = PageView::forResource($activityInstance->id, $moduleInstance->id)->count();

Accessing id on the interface BristolSU\Support\ModuleInstance\Contracts\ModuleInstance suggest that you code against a concrete implementation. How about adding an instanceof check?

        $needed = ( $settings['number_of_views'] ?? 1);
        
        $percentage = (int) round(($count/$needed) * 100, 0);
        
        if($percentage > 100) {

Expected "if (...) {\n"; found "if(...) {\n"

            return 100;
        }
        return $percentage;
    }

    /**
     * Options required by the completion condition.
     *
     * Any settings requested in here will be passed into the percentage or isComplete methods.
     *
     * @return Form
     * @throws \Exception
     */
    public function options(): Form
    {
        return \FormSchema\Generator\Form::make()->withField(
            \FormSchema\Generator\Field::input('number_of_views')->inputType('number')->label('Number of Views')
                ->required(true)->default(1)->hint('The number of times a user needs to view the page')
                ->help('The number of times a user should view the page before the module is marked as complete. 1 will mark the module as complete on the first view, 2 on the second etc.')
        )->getSchema();
    }

    /**
     * A name for the completion condition
     *
     * @return string
     */
    public function name(): string
    {
        return 'Has viewed the page';
    }

    /**
     * A description of the completion condition
     *
     * @return string
     */
    public function description(): string
    {
        return 'Marked as complete when the user/group/role has viewed the page a number of times.';
    }

    /**
     * The alias of the completion condition
     *
     * @return string
     */
    public function alias(): string
    {
        return 'static_page_has_viewed_page';
    }
}