bristol-su / control

src/Repositories/Position.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Repositories;

use BristolSU\ControlDB\Contracts\Models\Position as PositionModel;
use BristolSU\ControlDB\Contracts\Repositories\Position as PositionContract;
use Illuminate\Support\Collection;

/**
 * Handles positions
 */

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

class Position implements PositionContract
{

    /**
     * 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 \BristolSU\ControlDB\Models\Position::findOrFail($id);
    }

    /**
     * Get all positions
     *
     * @return Collection|PositionModel[]
     */
    public function all(): Collection
    {
        return \BristolSU\ControlDB\Models\Position::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
    {
        return \BristolSU\ControlDB\Models\Position::create([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'data_provider_id' => $dataProviderId
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

    }

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

Missing parameter comment

     */

Missing @return tag in function comment

    public function delete(int $id): void
    {
        \BristolSU\ControlDB\Models\Position::findOrFail($id)->delete();
    }

    /**
     * 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 {

Opening brace should be on a new line

        return \BristolSU\ControlDB\Models\Position::where('data_provider_id', $dataProviderId)->firstOrFail();
    }

    /**
     * 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 \BristolSU\ControlDB\Models\Position::paginate($perPage, ['*'], 'page', $page)->getCollection();
    }

    /**
     * Get the number of positions
     *
     * @return int
     */
    public function count(): int
    {
        return \BristolSU\ControlDB\Models\Position::count();

The expression return BristolSU\ControlDB\Models\Position::count() could return the type Illuminate\Database\Eloquent\Builder which is incompatible with the type-hinted return integer. Consider adding an additional type-check to rule them out.

    }

    /**
     * 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
    {
        $position = $this->getById($id)->fill(['data_provider_id' => $dataProviderId]);
        $position->save();
        return $position;
    }
}