bristol-su / control

src/Traits/GroupTrait.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Traits;

use BristolSU\ControlDB\Contracts\Models\DataGroup;
use BristolSU\ControlDB\Contracts\Repositories\Group;
use BristolSU\ControlDB\Contracts\Repositories\Pivots\Tags\GroupGroupTag;
use BristolSU\ControlDB\Contracts\Repositories\Pivots\UserGroup;
use BristolSU\ControlDB\Contracts\Repositories\Role;
use Illuminate\Support\Collection;

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

    /**
     * Get the data group for this group
     * 
     * @return DataGroup
     */
    public function data(): DataGroup
    {
        return app(\BristolSU\ControlDB\Contracts\Repositories\DataGroup::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(Group::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?

    }

    /**
     * Members of the group
     *
     * @return Collection
     */
    public function members(): Collection
    {
        return app(UserGroup::class)->getUsersThroughGroup($this);

$this of type BristolSU\ControlDB\Traits\GroupTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\Group expected by parameter $group of BristolSU\ControlDB\Contracts\Repositories\Pivots\UserGroup::getUsersThroughGroup().

    }

    /**
     * Roles belonging to the group
     *
     * @return Collection
     */
    public function roles(): Collection
    {
        return app(Role::class)->allThroughGroup($this);

$this of type BristolSU\ControlDB\Traits\GroupTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\Group expected by parameter $group of BristolSU\ControlDB\Contracts\Repositories\Role::allThroughGroup().

    }

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

$this of type BristolSU\ControlDB\Traits\GroupTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\Group expected by parameter $group of BristolSU\ControlDB\Contracts\Repositories\Pivots\Tags\GroupGroupTag::getTagsThroughGroup().

    }

    /**
     * Add a tag to the group
     * 
     * @param \BristolSU\ControlDB\Contracts\Models\Tags\GroupTag $groupTag

Missing parameter comment

     */

Missing @return tag in function comment

    public function addTag(\BristolSU\ControlDB\Contracts\Models\Tags\GroupTag $groupTag): void
    {
        app(GroupGroupTag::class)->addTagToGroup($groupTag, $this);

$this of type BristolSU\ControlDB\Traits\GroupTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\Group expected by parameter $group of BristolSU\ControlDB\Contracts\Repositories\Pivots\Tags\GroupGroupTag::addTagToGroup().

    }

    /**
     * Remove a tag from the group
     * 
     * @param \BristolSU\ControlDB\Contracts\Models\Tags\GroupTag $groupTag

Missing parameter comment

     */

Missing @return tag in function comment

    public function removeTag(\BristolSU\ControlDB\Contracts\Models\Tags\GroupTag $groupTag): void
    {
        app(GroupGroupTag::class)->removeTagFromGroup($groupTag, $this);

$this of type BristolSU\ControlDB\Traits\GroupTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\Group expected by parameter $group of BristolSU\ControlDB\Contracts\Repositories\Pivots\Tags\GroupGroupTag::removeTagFromGroup().

    }

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

Missing parameter comment

     */

Missing @return tag in function comment

    public function addUser(\BristolSU\ControlDB\Contracts\Models\User $user): void
    {
        app(UserGroup::class)->addUserToGroup($user, $this);

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

    }

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

Missing parameter comment

     */

Missing @return tag in function comment

    public function removeUser(\BristolSU\ControlDB\Contracts\Models\User $user): void
    {
        app(UserGroup::class)->removeUserFromGroup($user, $this);

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

    }


}