bristol-su / assign-roles

app/Events/UserAssigned.php

<?php

Missing file doc comment

namespace BristolSU\Module\AssignRoles\Events;

use BristolSU\ControlDB\Contracts\Models\Role;
use BristolSU\ControlDB\Contracts\Models\User;
use BristolSU\Support\Action\Contracts\TriggerableEvent;

class UserAssigned implements TriggerableEvent

Missing doc comment for class UserAssigned

{

    /**

Missing short description in doc comment

     * @var User
     */
    private $user;

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

    /**

Missing short description in doc comment

     * @var Role
     */
    private $role;

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

    public function __construct(User $user, Role $role)

Missing doc comment for function __construct()

    {
        $this->user = $user;
        $this->role = $role;
    }

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public function getFields(): array
    {
        return [
            'role_id' => $this->role->id(),
            'position_id' => $this->role->positionId(),
            'position_name' => $this->role->position()->data()->name(),
            'role_name' => $this->role->data()->roleName(),
            'role_email' => $this->role->data()->email(),
            'user_id' => $this->user->id(),
            'user_first_name' => $this->user->data()->firstName(),
            'user_last_name' => $this->user->data()->lastName(),
            'user_preferred_name' => $this->user->data()->preferredName(),
            'user_email' => $this->user->data()->email()
        ];
    }

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public static function getFieldMetaData(): array
    {
        return [
            'role_id' => [
                'label' => 'Role ID',
                'helptext' => 'ID of the role that was assigned to'
            ],
            'position_id' => [
                'label' => 'Position ID',
                'helptext' => 'ID of the position that was assigned to'
            ],
            'position_name' => [
                'label' => 'Position Name',
                'helptext' => 'Name of the position that was assigned to'
            ],
            'role_name' => [
                'label' => 'Role Name',
                'helptext' => 'Custom name for the role that was assigned to'
            ],
            'role_email' => [
                'label' => 'Role Email',
                'helptext' => 'Email of the role that was assigned to'
            ],
            'user_id' => [
                'label' => 'User ID',
                'helptext' => 'ID of the user that was assigned'
            ],
            'user_first_name' => [
                'label' => 'User First Name',
                'helptext' => 'First name of the user that was assigned'
            ],
            'user_last_name' => [
                'label' => 'User Last Name',
                'helptext' => 'Last name of the user that was assigned'
            ],
            'user_preferred_name' => [
                'label' => 'User Preferred Name',
                'helptext' => 'Preferred name of the user that was assigned'
            ],
            'user_email' => [
                'label' => 'User Email',
                'helptext' => 'Email of the user that was assigned'
            ]
        ];
    }
}