bristol-su / control

src/Traits/RoleTrait.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Traits;


use BristolSU\ControlDB\Contracts\Models\DataRole as DataRoleModel;
use BristolSU\ControlDB\Contracts\Models\User;
use BristolSU\ControlDB\Contracts\Repositories\DataRole as DataRoleRepository;
use BristolSU\ControlDB\Contracts\Repositories\Pivots\Tags\RoleRoleTag;
use BristolSU\ControlDB\Contracts\Repositories\Pivots\UserRole;
use BristolSU\ControlDB\Contracts\Repositories\Role;
use BristolSU\ControlDB\Models\Group;
use BristolSU\ControlDB\Models\Position;
use Illuminate\Support\Collection;

/**
 * Implements common methods using repositories required by the role model interface
 */

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 RoleTrait
{

    /**
     * Get the data attributes of the role
     * 
     * @return DataRoleModel
     */
    public function data(): DataRoleModel
    {
        return app(DataRoleRepository::class)->getById($this->dataProviderId());

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

    }

    /**
     * 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
    {
        app(Role::class)->update($this->id(), $this->positionId(), $this->groupId(), $dataProviderId);

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

The method groupId() does not exist on BristolSU\ControlDB\Traits\RoleTrait. Did you maybe mean group()?

The method positionId() does not exist on BristolSU\ControlDB\Traits\RoleTrait. Did you maybe mean position()?

    }

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

Missing parameter comment

     */

Missing @return tag in function comment

    public function setGroupId(int $groupId): void
    {
        app(Role::class)->update($this->id(), $this->positionId(), $groupId, $this->dataProviderId());
    }

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

Missing parameter comment

     */

Missing @return tag in function comment

    public function setPositionId(int $positionId): void
    {
        app(Role::class)->update($this->id(), $positionId, $this->groupId(), $this->dataProviderId());
    }

    /**
     * Position belonging to the role
     *
     * @return Position
     */
    public function position(): \BristolSU\ControlDB\Contracts\Models\Position
    {
        return app(\BristolSU\ControlDB\Contracts\Repositories\Position::class)->getById($this->positionId());
    }

    /**
     * Group belonging to the role
     *
     * @return Group
     */
    public function group(): \BristolSU\ControlDB\Contracts\Models\Group
    {
        return app(\BristolSU\ControlDB\Contracts\Repositories\Group::class)->getById($this->groupId());
    }

    /**
     * Users who occupy the role
     *
     * @return Collection
     */
    public function users(): Collection
    {
        return app(UserRole::class)->getUsersThroughRole($this);

$this of type BristolSU\ControlDB\Traits\RoleTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\Role expected by parameter $role of BristolSU\ControlDB\Contracts\Repositories\Pivots\UserRole::getUsersThroughRole().

    }

    /**
     * Tags the role is tagged with
     *
     * @return Collection
     */
    public function tags(): Collection
    {
        return app(RoleRoleTag::class)->getTagsThroughRole($this);

$this of type BristolSU\ControlDB\Traits\RoleTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\Role expected by parameter $role of BristolSU\ControlDB\Contracts\Repositories\Pivots\Tags\RoleRoleTag::getTagsThroughRole().

    }

    /**
     * Add a tag to the role
     * 
     * @param \BristolSU\ControlDB\Contracts\Models\Tags\RoleTag $roleTag

Missing parameter comment

     */

Missing @return tag in function comment

    public function addTag(\BristolSU\ControlDB\Contracts\Models\Tags\RoleTag $roleTag): void
    {
        app(RoleRoleTag::class)->addTagToRole($roleTag, $this);

$this of type BristolSU\ControlDB\Traits\RoleTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\Role expected by parameter $role of BristolSU\ControlDB\Contracts\Repositories\Pivots\Tags\RoleRoleTag::addTagToRole().

    }

    /**
     * Remove a tag from the role
     * 
     * @param \BristolSU\ControlDB\Contracts\Models\Tags\RoleTag $roleTag

Missing parameter comment

     */

Missing @return tag in function comment

    public function removeTag(\BristolSU\ControlDB\Contracts\Models\Tags\RoleTag $roleTag): void
    {
        app(RoleRoleTag::class)->removeTagFromRole($roleTag, $this);

$this of type BristolSU\ControlDB\Traits\RoleTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\Role expected by parameter $role of BristolSU\ControlDB\Contracts\Repositories\Pivots\Tags\RoleRoleTag::removeTagFromRole().

    }

    /**
     * Add a user to the role
     * 
     * @param User $user

Missing parameter comment

     */

Missing @return tag in function comment

    public function addUser(User $user): void
    {
        app(UserRole::class)->addUserToRole($user, $this);

$this of type BristolSU\ControlDB\Traits\RoleTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\Role expected by parameter $role of BristolSU\ControlDB\Contracts\Repositories\Pivots\UserRole::addUserToRole().

    }

    /**
     * Remove a user from the role
     * 
     * @param User $user

Missing parameter comment

     */

Missing @return tag in function comment

    public function removeUser(User $user): void
    {
        app(UserRole::class)->removeUserFromRole($user, $this);

$this of type BristolSU\ControlDB\Traits\RoleTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\Role expected by parameter $role of BristolSU\ControlDB\Contracts\Repositories\Pivots\UserRole::removeUserFromRole().

    }

}