bristol-su / control

src/Traits/PositionTrait.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Traits;


use BristolSU\ControlDB\Contracts\Models\DataPosition as DataPositionModel;
use BristolSU\ControlDB\Contracts\Repositories\DataPosition as DataPositionRepository;
use BristolSU\ControlDB\Contracts\Repositories\Pivots\Tags\PositionPositionTag;
use BristolSU\ControlDB\Contracts\Repositories\Position;
use Illuminate\Support\Collection;

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

    /**
     * Get the data model for this position
     * 
     * @return DataPositionModel
     */
    public function data(): DataPositionModel
    {
        return app(DataPositionRepository::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(Position::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?

    }

    /**
     * Roles with this position
     *
     * @return Collection
     */
    public function roles(): Collection
    {
        return app(\BristolSU\ControlDB\Contracts\Repositories\Role::class)->allThroughPosition($this);

$this of type BristolSU\ControlDB\Traits\PositionTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\Position expected by parameter $position of BristolSU\ControlDB\Contracts\Repositories\Role::allThroughPosition().

    }

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

$this of type BristolSU\ControlDB\Traits\PositionTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\Position expected by parameter $position of BristolSU\ControlDB\Contracts\Repositories\Pivots\Tags\PositionPositionTag::getTagsThroughPosition().

    }

    /**
     * Add a tag to the position
     * 
     * @param \BristolSU\ControlDB\Contracts\Models\Tags\PositionTag $positionTag

Missing parameter comment

     */

Missing @return tag in function comment

    public function addTag(\BristolSU\ControlDB\Contracts\Models\Tags\PositionTag $positionTag): void
    {
        app(PositionPositionTag::class)->addTagToPosition($positionTag, $this);

$this of type BristolSU\ControlDB\Traits\PositionTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\Position expected by parameter $position of BristolSU\ControlDB\Contracts\Repositories\Pivots\Tags\PositionPositionTag::addTagToPosition().

    }

    /**
     * Remove a tag from the position
     * 
     * @param \BristolSU\ControlDB\Contracts\Models\Tags\PositionTag $positionTag

Missing parameter comment

     */

Missing @return tag in function comment

    public function removeTag(\BristolSU\ControlDB\Contracts\Models\Tags\PositionTag $positionTag): void
    {
        app(PositionPositionTag::class)->removeTagFromPosition($positionTag, $this);

$this of type BristolSU\ControlDB\Traits\PositionTrait is incompatible with the type BristolSU\ControlDB\Contracts\Models\Position expected by parameter $position of BristolSU\ControlDB\Contracts\Repositories\Pivots\Tags\PositionPositionTag::removeTagFromPosition().

    }
    
}