bristol-su / control

src/Models/DataRole.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Models;


use BristolSU\ControlDB\AdditionalProperties\HasAdditionalProperties;
use BristolSU\ControlDB\Traits\DataRoleTrait;
use DateTime;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

/**
 * Handles attributes belonging to a role
 */

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

class DataRole extends Model implements \BristolSU\ControlDB\Contracts\Models\DataRole
{
    use SoftDeletes, HasAdditionalProperties, DataRoleTrait {
        setRoleName as baseSetRoleName;
        setEmail as baseSetEmail;
    }

    /**
     * The table to use
     * 
     * @var string 
     */
    protected $table = 'control_data_role';

    /**
     * Fillable attributes
     * 
     * @var array 
     */
    protected $fillable = [
        'role_name', 'email'
    ];

    /**
     * Get the ID of the role
     *
     * @return int
     */
    public function id(): int
    {
        return $this->id;
    }



    /**
     * Get the email of the role
     *
     * @return string|null
     */
    public function email(): ?string
    {
        return $this->email;
    }

    /**
     * Get the name for the role
     * 
     * @return string|null
     */
    public function roleName(): ?string
    {
        return $this->role_name;
    }

    /**
     * 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
    {
        $this->baseSetEmail($email);
        $this->refresh();
    }

    /**
     * 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
    {
        $this->baseSetRoleName($roleName);
        $this->refresh();
    }


}