bristol-su / control

src/Observers/NotifyObservers/DataUserNotifier.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Observers\NotifyObservers;

use BristolSU\ControlDB\Contracts\Repositories\DataUser as DataUserRepository;
use BristolSU\ControlDB\Observers\NotifyObservers\Framework\Notifier;
use BristolSU\ControlDB\Observers\NotifyObservers\Framework\ObserverStore;
use Illuminate\Support\Collection;

class DataUserNotifier extends Notifier implements DataUserRepository

Missing doc comment for class DataUserNotifier

{

    /**

Missing short description in doc comment

     * @var DataUserRepository
     */
    private $dataUserRepository;

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

    public function __construct(DataUserRepository $dataUserRepository, ObserverStore $observerStore)

Missing doc comment for function __construct()

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

    /**
     * Get a data user by ID
     * 
     *
     * @param int $id

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

Missing parameter comment

     * @return \BristolSU\ControlDB\Contracts\Models\DataUser

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

     */
    public function getById(int $id): \BristolSU\ControlDB\Contracts\Models\DataUser
    {
        return $this->dataUserRepository->getById($id);
    }

    /**
     * Get a data user where the given attributes match, including additional attributes.
     *
     * @param array $attributes

Missing parameter comment

     * @return \BristolSU\ControlDB\Contracts\Models\DataUser

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

     */
    public function getWhere($attributes = []): \BristolSU\ControlDB\Contracts\Models\DataUser
    {
        return $this->dataUserRepository->getWhere($attributes);
    }

    /**
     * Get all data users where the given attributes match, including additional attributes.
     *
     * @param array $attributes

Missing parameter comment

     * @return Collection|\BristolSU\ControlDB\Contracts\Models\DataUser[]

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

     */
    public function getAllWhere($attributes = []): Collection
    {
        return $this->dataUserRepository->getAllWhere($attributes);
    }

    /**
     * Create a data user with the given attributes
     *
     * @param string|null $firstName First name of the user

Expected 4 spaces after parameter type; 1 found

Expected 5 spaces after parameter name; 1 found

     * @param string|null $lastName Last name of the user

Expected 4 spaces after parameter type; 1 found

Expected 6 spaces after parameter name; 1 found

     * @param string|null $email Email of the user

Expected 4 spaces after parameter type; 1 found

Expected 9 spaces after parameter name; 1 found

     * @param \DateTime|null $dob Date of birth of the user

Expected 11 spaces after parameter name; 1 found

     * @param string|null $preferredName Preferred name of the user

Expected 4 spaces after parameter type; 1 found

     *
     * @return \BristolSU\ControlDB\Contracts\Models\DataUser
     */
    public function create(?string $firstName = null, ?string $lastName = null, ?string $email = null, ?\DateTime $dob = null, ?string $preferredName = null): \BristolSU\ControlDB\Contracts\Models\DataUser
    {
        $dataUser = $this->dataUserRepository->create($firstName, $lastName, $email, $dob, $preferredName);
        $this->notify('create', $dataUser);
        return $dataUser;
    }

    /**
     * Update a data user
     *
     * @param int $id

Missing parameter comment

Expected 12 spaces after parameter type; 1 found

     * @param string|null $firstName

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     * @param string|null $lastName

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     * @param string|null $email

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     * @param \DateTime|null $dob

Missing parameter comment

     * @param string|null $preferredName

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     * @return \BristolSU\ControlDB\Contracts\Models\DataUser

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

     */
    public function update(int $id, ?string $firstName = null, ?string $lastName = null, ?string $email = null, ?\DateTime $dob = null, ?string $preferredName = null): \BristolSU\ControlDB\Contracts\Models\DataUser
    {
        $oldDataUser = $this->getById($id);
        $newDataUser = $this->dataUserRepository->update($id, $firstName, $lastName, $email, $dob, $preferredName);
        $this->notify('update', $oldDataUser, $newDataUser);
        return $newDataUser;
    }
}