bristol-su / control

src/Contracts/Models/DataUser.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Contracts\Models;

use BristolSU\ControlDB\AdditionalProperties\ImplementsAdditionalProperties;
use DateTime;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Jsonable;

/**
 * Handles attributes about a user
 */

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

interface DataUser extends ImplementsAdditionalProperties, Arrayable, Jsonable
{

    /**
     * Get the ID of the data user
     * 
     * @return int
     */
    public function id(): int;

    /**
     * Get the first name of the data user
     * 
     * @return string|null
     */
    public function firstName(): ?string;

    /**
     * Get the last name of the user
     * 
     * @return string|null
     */
    public function lastName(): ?string;

    /**
     * Get the email of the user
     * @return string|null

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

     */
    public function email(): ?string;

    /**
     * Get the date of birth of the user
     * 
     * @return DateTime|null
     */
    public function dob(): ?DateTime;

    /**
     * Get the preferred name of the user
     * 
     * @return string|null
     */
    public function preferredName(): ?string;

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

Missing parameter comment

     */

Missing @return tag in function comment

    public function setFirstName(?string $firstName): void;

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

Missing parameter comment

     */

Missing @return tag in function comment

    public function setLastName(?string $lastName): void;

    /**
     * Set the email of the user
     * 
     * @param string|null $email

Missing parameter comment

     */

Missing @return tag in function comment

    public function setEmail(?string $email): void;

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

Missing parameter comment

     */

Missing @return tag in function comment

    public function setDob(?DateTime $dob): void;

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

Missing parameter comment

     */

Missing @return tag in function comment

    public function setPreferredName(?string $name): void;

    /**
     * Get the user using this data user
     * 
     * @return User|null
     */
    public function user(): ?User;

}