bristol-su / control

src/Traits/DataUserTrait.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Traits;


use BristolSU\ControlDB\Contracts\Models\User;
use DateTime;
use Illuminate\Database\Eloquent\ModelNotFoundException;

/**
 * Implements methods to the data user interface using repositories
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

trait DataUserTrait
{

    /**
     * Get the user using the data user
     *
     * @return User|null
     */
    public function user(): ?User
    {
        try {
            return app(\BristolSU\ControlDB\Contracts\Repositories\User::class)->getByDataProviderId($this->id());

It seems like id() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        } catch (ModelNotFoundException $e) {
            return null;
        }
    }

    /**
     * Set the users first name
     *
     * @param string|null $firstName

Missing parameter comment

     */

Missing @return tag in function comment

    public function setFirstName(?string $firstName): void
    {
        app(\BristolSU\ControlDB\Contracts\Repositories\DataUser::class)->update(
            $this->id(), $firstName, $this->lastName(), $this->email(), $this->dob(), $this->preferredName()

It seems like lastName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

It seems like email() must be provided by classes using this trait. How about adding it as abstract method to this trait?

It seems like preferredName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

It seems like dob() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        );
    }

    /**
     * Set the users last name
     *
     * @param string|null $lastName

Missing parameter comment

     */

Missing @return tag in function comment

    public function setLastName(?string $lastName): void
    {
        app(\BristolSU\ControlDB\Contracts\Repositories\DataUser::class)->update(
            $this->id(), $this->firstName(), $lastName, $this->email(), $this->dob(), $this->preferredName()

It seems like firstName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        );
    }

    /**
     * Set the users email
     *
     * @param string|null $email

Missing parameter comment

     */

Missing @return tag in function comment

    public function setEmail(?string $email): void
    {
        app(\BristolSU\ControlDB\Contracts\Repositories\DataUser::class)->update(
            $this->id(), $this->firstName(), $this->lastName(), $email, $this->dob(), $this->preferredName()
        );
    }

    /**
     * Set the date of birth attribute
     *
     * @param DateTime|null $dob

Missing parameter comment

     */

Missing @return tag in function comment

    public function setDob(?DateTime $dob): void
    {
        app(\BristolSU\ControlDB\Contracts\Repositories\DataUser::class)->update(
            $this->id(), $this->firstName(), $this->lastName(), $this->email(), $dob, $this->preferredName()
        );
    }

    /**
     * Set the preferred name for the user
     *
     * @param string|null $name

Missing parameter comment

     */

Missing @return tag in function comment

    public function setPreferredName(?string $name): void
    {
        app(\BristolSU\ControlDB\Contracts\Repositories\DataUser::class)->update(
            $this->id(), $this->firstName(), $this->lastName(), $this->email(), $this->dob(), $name
        );
    }
}