BristolSU\ControlDB\Observers\NotifyObservers\UserNotifier

Complexity

Total Complexity

9

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	all()	0	3	1
A	create()	0	5	1
A	getById()	0	3	1
A	update()	0	6	1
A	getByDataProviderId()	0	3	1
A	count()	0	3	1
A	__construct()	0	4	1
A	paginate()	0	3	1
A	delete()	0	5	1

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Observers\NotifyObservers;

use BristolSU\ControlDB\Contracts\Models\User as UserModel;
use BristolSU\ControlDB\Contracts\Repositories\User as UserRepository;
use BristolSU\ControlDB\Observers\NotifyObservers\Framework\Notifier;
use BristolSU\ControlDB\Observers\NotifyObservers\Framework\ObserverStore;
use Illuminate\Support\Collection;

class UserNotifier extends Notifier implements UserRepository

Missing doc comment for class UserNotifier

{

    /**

Missing short description in doc comment

     * @var UserRepository
     */
    private $userRepository;

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

    public function __construct(UserRepository $userRepository, ObserverStore $observerStore)

Missing doc comment for function __construct()

    {
        parent::__construct($observerStore, UserRepository::class);
        $this->userRepository = $userRepository;
    }

    /**
     * Get a user by ID
     *
     * @param int $id ID of the user
     * @return UserModel

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

     */
    public function getById(int $id): UserModel
    {
        return $this->userRepository->getById($id);
    }

    /**
     * Get a user by its data provider ID
     *
     * @param int $dataProviderId

Missing parameter comment

     * @return UserModel

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

     */
    public function getByDataProviderId(int $dataProviderId): UserModel
    {
        return $this->userRepository->getByDataProviderId($dataProviderId);
    }

    /**
     * Get all users
     *
     * @return Collection|UserModel[]
     */
    public function all(): Collection
    {
        return $this->userRepository->all();
    }

    /**
     * Create a new user
     *
     * @param int $dataProviderId

Missing parameter comment

     * @return UserModel

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

     */
    public function create(int $dataProviderId): UserModel
    {
        $userModel = $this->userRepository->create($dataProviderId);
        $this->notify('create', $userModel);
        return $userModel;
    }

    /**
     * Delete a user by ID
     *
     * @param int $id

Missing parameter comment

     */

Missing @return tag in function comment

    public function delete(int $id): void
    {
        $userModel = $this->getById($id);
        $this->userRepository->delete($id);
        $this->notify('delete', $userModel);
    }

    /**
     * Update the user model
     *
     * @param int $id

Missing parameter comment

     * @param int $dataProviderId New data provider ID
     * @return UserModel

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

     */
    public function update(int $id, int $dataProviderId): UserModel
    {
        $oldUserModel = $this->getById($id);
        $newUserModel = $this->userRepository->update($id, $dataProviderId);
        $this->notify('update', $oldUserModel, $newUserModel);
        return $newUserModel;
    }

    /**
     * Paginate through all the users
     *
     * @param int $page The page number to return

Expected 4 spaces after parameter name; 1 found

     * @param int $perPage The number of results to return per page
     *
     * @return Collection|UserModel[]
     */
    public function paginate(int $page, int $perPage): Collection
    {
        return $this->userRepository->paginate($page, $perPage);
    }

    /**
     * Get the number of users
     *
     * @return int
     */
    public function count(): int
    {
        return $this->userRepository->count();
    }
}