bristol-su / static-page

app/Events/ButtonUnsubmitted.php

<?php

Missing file doc comment

namespace BristolSU\Module\StaticPage\Events;

use BristolSU\Module\StaticPage\Models\ButtonClick;
use BristolSU\Module\StaticPage\Models\PageView;
use BristolSU\Support\Action\Contracts\TriggerableEvent;
use BristolSU\Support\ActivityInstance\Contracts\ActivityInstanceRepository;
use BristolSU\Support\ModuleInstance\Contracts\ModuleInstanceRepository;

class ButtonUnsubmitted implements TriggerableEvent

Missing doc comment for class ButtonUnsubmitted

{

    /**

Missing short description in doc comment

     * @var ButtonClick
     */
    private $buttonClick;

Private member variable "buttonClick" must be prefixed with an underscore

    public function __construct(ButtonClick $buttonClick)

Missing doc comment for function __construct()

    {

        $this->buttonClick = $buttonClick;
    }

    /**
     * Register metadata about the fields the event supplies.
     *
     * For each field returned in getFields, pass in a label and a helptext.
     * e.g. [
     *      'user_id' => [
     *          'label' => 'User ID',
     *          'helptext' => 'The ID of the user who posted the comment.'
     *          ],
     *      ...
     * ]
     * @return array

There must be exactly one blank line before the tags in a doc comment

     */
    public static function getFieldMetaData(): array
    {
        return [
          'user_id' => [
            'label' => 'User ID',
            'helptext' => 'The ID of the user'
          ],
          'user_email' => [
            'label' => 'Email Address',
            'helptext' => 'Email Address of the user. May be empty.'
          ],
          'user_first_name' => [
            'label' => 'First Name',
            'helptext' => 'First Name of the user. May be empty.'
          ],
          'user_last_name' => [
            'label' => 'Last Name',
            'helptext' => 'Last Name of the user. May be empty.'
          ],
          'user_preferred_name' => [
            'label' => 'Preferred Name',
            'helptext' => 'Preferred Name of the user. May be empty.'
          ],
          'module_instance_id' => [
            'label' => 'Module Instance ID',
            'helptext' => 'ID of the module instance viewed'
          ],
          'module_instance_name' => [
            'label' => 'Module Instance Name',
            'helptext' => 'Name of the module instance viewed.'
          ],
          'activity_instance_id' => [
            'label' => 'Activity Instance ID',
            'helptext' => 'The id of the activity instance viewed.'
          ],
          'activity_instance_name' => [
            'label' => 'Activity Instance Name',
            'helptext' => 'The name of the activity instance viewed.'
          ],
          'clicked_at' => [
            'label' => 'Button Clicked At',
            'helptext' => 'The date and time the button was clicked at'
          ],
          'unsubmitted_at' => [
            'label' => 'Button Unsubmitted At',
            'helptext' => 'The date and time the button was unsubmitted at'
          ],
        ];
    }

    /**
     * Get the fields that the event registers.
     *
     * If the event has parameters which should be used in the framework, return them here.
     *
     * e.g. [
     *      'user_id' => 1,
     *      'comment_id' => 4,
     *      'post_id' => 3
     * ]
     * @return array

There must be exactly one blank line before the tags in a doc comment

     */
    public function getFields(): array
    {
        $moduleInstance = app(ModuleInstanceRepository::class)->getById($this->buttonClick->module_instance_id);
        $activityInstance = app(ActivityInstanceRepository::class)->getById($this->buttonClick->activity_instance_id);
        return [
          'user_id' => $this->buttonClick->user->id(),
          'user_email' => $this->buttonClick->user->data()->email(),
          'user_first_name' => $this->buttonClick->user->data()->firstName(),
          'user_last_name' => $this->buttonClick->user->data()->lastName(),
          'user_preferred_name' => $this->buttonClick->user->data()->preferredName(),
          'clicked_at' => $this->buttonClick->created_at->format('Y-m-d H:i:s'),
          'unsubmitted_at' => $this->buttonClick->deleted_at->format('Y-m-d H:i:s'),
          'module_instance_id' => $moduleInstance->id,

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

          'module_instance_name' => $moduleInstance->name,

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

          'activity_instance_id' => $activityInstance->id,
          'activity_instance_name' => $activityInstance->name,
        ];
    }
}