bristol-su / control

src/Repositories/DataUser.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Repositories;

use DateTime;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Support\Collection;

class DataUser implements \BristolSU\ControlDB\Contracts\Repositories\DataUser

Missing doc comment for class DataUser

{

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

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 \BristolSU\ControlDB\Models\DataUser::findOrFail($id);

The expression return BristolSU\ControlDB\Models\DataUser::findOrFail($id) could return the type null which is incompatible with the type-hinted return BristolSU\ControlDB\Contracts\Models\DataUser. Consider adding an additional type-check to rule them out.

    }

    /**
     * Get a data user with the given attributes, 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
    {
        $users = $this->getAllWhere($attributes);

        if ($users->count() > 0) {
            return $users->first();
        }
        throw (new ModelNotFoundException())->setModel(DataUser::class);
    }

    /**
     * Create a new data user
     *
     * @param string|null $firstName

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     * @param string|null $lastName

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     * @param string|null $email

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     * @param DateTime|null $dob

Missing parameter comment

     * @param string|null $preferredName

Missing parameter comment

Expected 3 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 create(?string $firstName = null, ?string $lastName = null, ?string $email = null, ?DateTime $dob = null, ?string $preferredName = null): \BristolSU\ControlDB\Contracts\Models\DataUser
    {
        return \BristolSU\ControlDB\Models\DataUser::create([

The expression return BristolSU\ControlDB\Models\DataUser::create(array('first_name' => $firstName, 'last_name' => $lastName, 'email' => $email, 'dob' => $dob, 'preferred_name' => $preferredName)) could return the type null which is incompatible with the type-hinted return BristolSU\ControlDB\Contracts\Models\DataUser. Consider adding an additional type-check to rule them out.

The opening parenthesis of a multi-line function call should be the last content on the line.

            'first_name' => $firstName,
            'last_name' => $lastName,
            'email' => $email,
            'dob' => $dob,
            'preferred_name' => $preferredName
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

    }

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

Missing parameter comment

     * @return Collection

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

     */
    public function getAllWhere($attributes = []): Collection
    {
        $baseAttributes = $attributes;
        $additionalAttributes = [];
        foreach (\BristolSU\ControlDB\Models\DataUser::getAdditionalAttributes() as $property) {
            if (array_key_exists($property, $baseAttributes)) {
                $additionalAttributes[$property] = $baseAttributes[$property];
                unset($baseAttributes[$property]);
            }
        }
        return \BristolSU\ControlDB\Models\DataUser::where(function($query) use ($baseAttributes) {

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

            foreach($baseAttributes as $key => $value) {

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

                $query = $query->where($key, 'LIKE', '%' . $value . '%');
            }
            return $query;
        })->get()->filter(function (\BristolSU\ControlDB\Models\DataUser $dataUser) use ($additionalAttributes) {

For multi-line function calls, the closing parenthesis should be on a new line.

The opening parenthesis of a multi-line function call should be the last content on the line.

            foreach ($additionalAttributes as $additionalAttribute => $value) {
                if ($dataUser->getAdditionalAttribute($additionalAttribute) !== $value) {
                    return false;
                }
            }
            return true;
        })->values();

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    /**
     * 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
    {
        $dataUser = $this->getById($id)->fill([

The method fill() does not exist on BristolSU\ControlDB\Contracts\Models\DataUser. Since it exists in all sub-types, consider adding an abstract or default implementation to BristolSU\ControlDB\Contracts\Models\DataUser.

The opening parenthesis of a multi-line function call should be the last content on the line.

            'first_name' => $firstName,
            'last_name' => $lastName,
            'email' => $email,
            'dob' => $dob,
            'preferred_name' => $preferredName
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        $dataUser->save();
        return $dataUser;
    }
}