bristol-su / control

src/Traits/DataPositionTrait.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Traits;


use BristolSU\ControlDB\Contracts\Models\Position;
use BristolSU\ControlDB\Contracts\Repositories\DataPosition;
use Illuminate\Database\Eloquent\ModelNotFoundException;

/**
 * Implements methods to the data position interface using repositories
 */

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

    /**
     * Get the position using the data position
     *
     * @return Position|null
     */
    public function position(): ?Position
    {
        try {
            return app(\BristolSU\ControlDB\Contracts\Repositories\Position::class)->getByDataProviderId($this->id());

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

        } catch (ModelNotFoundException $e) {
            return null;
        }
    }

    /**
     * Set the position name
     *
     * @param string|null $name

Missing parameter comment

     */

Missing @return tag in function comment

    public function setName(?string $name): void
    {
        app(DataPosition::class)->update($this->id(), $name, $this->description());

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

    }

    /**
     * Set the description
     *
     * @param string|null $description

Missing parameter comment

     */

Missing @return tag in function comment

    public function setDescription(?string $description): void
    {
        app(DataPosition::class)->update($this->id(), $this->name(), $description);

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

    }
}