bristol-su / control

src/Traits/UserTrait.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Traits;


use BristolSU\ControlDB\Contracts\Models\DataUser;
use BristolSU\ControlDB\Contracts\Models\Role;
use BristolSU\ControlDB\Contracts\Repositories\Pivots\Tags\UserUserTag;
use BristolSU\ControlDB\Contracts\Repositories\Pivots\UserGroup;
use BristolSU\ControlDB\Contracts\Repositories\Pivots\UserRole;
use BristolSU\ControlDB\Contracts\Repositories\User;
use BristolSU\ControlDB\Models\Group;
use BristolSU\ControlDB\Models\Tags\UserTag;
use Illuminate\Support\Collection;

/**
 * Implements common methods using repositories required by the user 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 UserTrait
{

    /**
     * Get the attributes for this user
     *
     * @return DataUser
     */
    public function data(): DataUser {

Opening brace should be on a new line

        return app(\BristolSU\ControlDB\Contracts\Repositories\DataUser::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(User::class)->update($this->id(), $dataProviderId);

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

    }
    
    /**
     * Tags the user is tagged with
     *
     * @return Collection
     */
    public function tags(): Collection
    {
        return app(UserUserTag::class)->getTagsThroughUser($this);

$this of type BristolSU\ControlDB\Traits\UserTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\User expected by parameter $user of BristolSU\ControlDB\Contracts\Repositories\Pivots\Tags\UserUserTag::getTagsThroughUser().

    }

    /**
     * Roles the user owns
     *
     * @return Collection
     */
    public function roles(): Collection
    {
        return app(UserRole::class)->getRolesThroughUser($this);

$this of type BristolSU\ControlDB\Traits\UserTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\User expected by parameter $user of BristolSU\ControlDB\Contracts\Repositories\Pivots\UserRole::getRolesThroughUser().

    }

    /**
     * Groups the user is a member of
     *
     * @return Collection
     */
    public function groups(): Collection
    {
        return app(UserGroup::class)->getGroupsThroughUser($this);

$this of type BristolSU\ControlDB\Traits\UserTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\User expected by parameter $user of BristolSU\ControlDB\Contracts\Repositories\Pivots\UserGroup::getGroupsThroughUser().

    }

    /**
     * Add a tag to the user
     * 
     * @param \BristolSU\ControlDB\Contracts\Models\Tags\UserTag $userTag

Missing parameter comment

     */

Missing @return tag in function comment

    public function addTag(\BristolSU\ControlDB\Contracts\Models\Tags\UserTag $userTag): void
    {
        app(UserUserTag::class)->addTagToUser($userTag, $this);

$this of type BristolSU\ControlDB\Traits\UserTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\User expected by parameter $user of BristolSU\ControlDB\Contracts\Repositories\Pivots\Tags\UserUserTag::addTagToUser().

    }

    /**
     * Remove a tag from the user
     * 
     * @param \BristolSU\ControlDB\Contracts\Models\Tags\UserTag $userTag

Missing parameter comment

     */

Missing @return tag in function comment

    public function removeTag(\BristolSU\ControlDB\Contracts\Models\Tags\UserTag $userTag): void
    {
        app(UserUserTag::class)->removeTagFromUser($userTag, $this);

$this of type BristolSU\ControlDB\Traits\UserTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\User expected by parameter $user of BristolSU\ControlDB\Contracts\Repositories\Pivots\Tags\UserUserTag::removeTagFromUser().

    }

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

Missing parameter comment

     */

Missing @return tag in function comment

    public function addRole(Role $role): void
    {
        app(UserRole::class)->addUserToRole($this, $role);

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

    }

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

Missing parameter comment

     */

Missing @return tag in function comment

    public function removeRole(Role $role): void
    {
        app(UserRole::class)->removeUserFromRole($this, $role);

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

    }

    /**
     * Add a group to the user
     * 
     * @param \BristolSU\ControlDB\Contracts\Models\Group $group

Missing parameter comment

     */

Missing @return tag in function comment

    public function addGroup(\BristolSU\ControlDB\Contracts\Models\Group $group): void
    {
        app(UserGroup::class)->addUserToGroup($this, $group);

$this of type BristolSU\ControlDB\Traits\UserTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\User expected by parameter $user of BristolSU\ControlDB\Contracts\Repositories\Pivots\UserGroup::addUserToGroup().

    }

    /**
     * Remove a group from the user
     * 
     * @param \BristolSU\ControlDB\Contracts\Models\Group $group

Missing parameter comment

     */

Missing @return tag in function comment

    public function removeGroup(\BristolSU\ControlDB\Contracts\Models\Group $group): void
    {
        app(UserGroup::class)->removeUserFromGroup($this, $group);

$this of type BristolSU\ControlDB\Traits\UserTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\User expected by parameter $user of BristolSU\ControlDB\Contracts\Repositories\Pivots\UserGroup::removeUserFromGroup().

    }
    
    
}