bristol-su / control

src/Models/Role.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Models;


use BristolSU\ControlDB\Traits\RoleTrait;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

/**
 * Represents 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 Role extends Model implements \BristolSU\ControlDB\Contracts\Models\Role
{

    use SoftDeletes, RoleTrait {
        setDataProviderId as baseSetDataProviderId;
        setGroupId as baseSetGroupId;
        setPositionId as baseSetPositionId;
    }

    /**
     * Table to use
     *
     * @var string
     */
    protected $table = 'control_roles';

    /**
     * Fillable attributes
     *
     * @var array
     */
    protected $fillable = ['data_provider_id', 'group_id', 'position_id'];

    /**
     * Attributes to append when casting to an array
     *
     * @var array
     */
    protected $appends = [
        'data'
    ];

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

    /**
     * ID of the data provider for the role
     *
     * @return int
     */
    public function dataProviderId(): int
    {
        return $this->data_provider_id;
    }

    /**
     * Laravel integration for a data property
     *
     * @return \BristolSU\ControlDB\Contracts\Models\DataRole
     */
    public function getDataAttribute(): \BristolSU\ControlDB\Contracts\Models\DataRole
    {
        return $this->data();
    }

    /**
     * ID of the position the role has
     *
     * @return mixed
     */
    public function positionId(): int
    {
        return $this->position_id;
    }

    /**
     * ID of the group the role belongs to
     *
     * @return mixed
     */
    public function groupId(): int
    {
        return $this->group_id;
    }

    /**
     * Set the ID of the data provider
     *
     * @param int $dataProviderId

Missing parameter comment

     */

Missing @return tag in function comment

    public function setDataProviderId(int $dataProviderId): void
    {
        $this->baseSetDataProviderId($dataProviderId);
        $this->refresh();
    }

    /**
     * Set a group ID
     *
     * @param int $groupId

Missing parameter comment

     */

Missing @return tag in function comment

    public function setGroupId(int $groupId): void
    {
        $this->baseSetGroupId($groupId);
        $this->refresh();
    }

    /**
     * Set a position ID
     *
     * @param int $positionId

Missing parameter comment

     */

Missing @return tag in function comment

    public function setPositionId(int $positionId): void
    {
        $this->baseSetPositionId($positionId);
        $this->refresh();
    }


}