bristol-su / control

src/Traits/DataRoleTrait.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Traits;


use BristolSU\ControlDB\Contracts\Models\Role;
use BristolSU\ControlDB\Contracts\Repositories\DataRole;
use Illuminate\Database\Eloquent\ModelNotFoundException;

/**
 * Implements methods to the data role 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 DataRoleTrait
{

    /**
     * Get the role using the data role
     *
     * @return Role|null
     */
    public function role(): ?Role
    {
        try {
            return app(\BristolSU\ControlDB\Contracts\Repositories\Role::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 email of the role
     *
     * @param string|null $email

Missing parameter comment

     */

Missing @return tag in function comment

    public function setEmail(?string $email): void
    {
        app(DataRole::class)->update($this->id(), $this->roleName(), $email);

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

    }


    /**
     * Set a name for the role
     *
     * @param string|null $roleName

Missing parameter comment

     */

Missing @return tag in function comment

    public function setRoleName(?string $roleName): void
    {
        app(DataRole::class)->update($this->id(), $roleName, $this->email());

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

    }
}