bristol-su / control

src/Observers/NotifyObservers/PositionNotifier.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Observers\NotifyObservers;

use BristolSU\ControlDB\Contracts\Models\Position as PositionModel;
use BristolSU\ControlDB\Contracts\Repositories\Position as PositionRepository;
use BristolSU\ControlDB\Observers\NotifyObservers\Framework\Notifier;
use BristolSU\ControlDB\Observers\NotifyObservers\Framework\ObserverStore;
use Illuminate\Support\Collection;

class PositionNotifier extends Notifier implements PositionRepository

Missing doc comment for class PositionNotifier

{

    /**

Missing short description in doc comment

     * @var PositionRepository
     */
    private $positionRepository;

Private member variable "positionRepository" must be prefixed with an underscore

    public function __construct(PositionRepository $positionRepository, ObserverStore $observerStore)

Missing doc comment for function __construct()

    {
        parent::__construct($observerStore, PositionRepository::class);
        $this->positionRepository = $positionRepository;
    }

    /**
     * Get a position by ID
     *
     * @param int $id ID of the position
     * @return PositionModel

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function getById(int $id): PositionModel
    {
        return $this->positionRepository->getById($id);
    }

    /**
     * Get a position by its data provider ID
     *
     * @param int $dataProviderId

Missing parameter comment

     * @return PositionModel

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function getByDataProviderId(int $dataProviderId): PositionModel
    {
        return $this->positionRepository->getByDataProviderId($dataProviderId);
    }

    /**
     * Get all positions
     *
     * @return Collection|PositionModel[]
     */
    public function all(): Collection
    {
        return $this->positionRepository->all();
    }

    /**
     * Create a new position
     *
     * @param int $dataProviderId

Missing parameter comment

     * @return PositionModel

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function create(int $dataProviderId): PositionModel
    {
        $positionModel = $this->positionRepository->create($dataProviderId);
        $this->notify('create', $positionModel);
        return $positionModel;
    }

    /**
     * Delete a position by ID
     *
     * @param int $id

Missing parameter comment

     */

Missing @return tag in function comment

    public function delete(int $id): void
    {
        $positionModel = $this->getById($id);
        $this->positionRepository->delete($id);
        $this->notify('delete', $positionModel);
    }

    /**
     * Update the position model
     *
     * @param int $id

Missing parameter comment

     * @param int $dataProviderId New data provider ID
     * @return PositionModel

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function update(int $id, int $dataProviderId): PositionModel
    {
        $oldPositionModel = $this->getById($id);
        $newPositionModel = $this->positionRepository->update($id, $dataProviderId);
        $this->notify('update', $oldPositionModel, $newPositionModel);
        return $newPositionModel;
    }

    /**
     * Paginate through all the positions
     *
     * @param int $page The page number to return

Expected 4 spaces after parameter name; 1 found

     * @param int $perPage The number of results to return per page
     *
     * @return Collection|PositionModel[]
     */
    public function paginate(int $page, int $perPage): Collection
    {
        return $this->positionRepository->paginate($page, $perPage);
    }

    /**
     * Get the number of positions
     *
     * @return int
     */
    public function count(): int
    {
        return $this->positionRepository->count();
    }
}