bristol-su / control

src/Repositories/Role.php

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Repositories;



use BristolSU\ControlDB\Contracts\Models\Role as RoleModel;
use BristolSU\ControlDB\Contracts\Repositories\Role as RoleContract;
use Illuminate\Support\Collection;

/**
 * Class Role
 */

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 Role implements RoleContract
{


    /**
     * Get a role by ID
     *
     * @param int $id

Missing parameter comment

     * @return RoleModel

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

     */
    public function getById(int $id): \BristolSU\ControlDB\Contracts\Models\Role
    {
        return \BristolSU\ControlDB\Models\Role::findOrFail($id);
    }

    /**
     * Get all roles
     *
     * @return Collection|\BristolSU\ControlDB\Contracts\Models\Role[]
     */
    public function all(): Collection
    {
        return \BristolSU\ControlDB\Models\Role::all();
    }

    /**
     * Create a new role
     *
     * @param int $positionId

Missing parameter comment

     * @param int $groupId

Missing parameter comment

     * @param int $dataProviderId

Missing parameter comment

     * @return RoleModel

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

     */
    public function create(int $positionId, int $groupId, int $dataProviderId): \BristolSU\ControlDB\Contracts\Models\Role
    {
        return \BristolSU\ControlDB\Models\Role::create([

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

            'position_id' => $positionId,
            'group_id' => $groupId,
            'data_provider_id' => $dataProviderId
        ]);

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

    }

    /**
     * Delete a role
     *
     * @param int $id

Missing parameter comment

     */

Missing @return tag in function comment

    public function delete(int $id): void
    {
        $this->getById($id)->delete();
    }

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

Missing parameter comment

     * @return RoleModel

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

     */
    public function getByDataProviderId(int $dataProviderId): \BristolSU\ControlDB\Contracts\Models\Role {

Opening brace should be on a new line

        return \BristolSU\ControlDB\Models\Role::where('data_provider_id', $dataProviderId)->firstOrFail();
    }
    
    /**
     * Get all roles that belong to the given group
     *
     * @param \BristolSU\ControlDB\Contracts\Models\Group $group

Missing parameter comment

     * @return Collection|RoleModel[]

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

     */
    public function allThroughGroup(\BristolSU\ControlDB\Contracts\Models\Group $group): Collection
    {
        return \BristolSU\ControlDB\Models\Role::where('group_id', $group->id())->get();
    }

    /**
     * Get all roles that belong to the given position
     * @param \BristolSU\ControlDB\Contracts\Models\Position $position

There must be exactly one blank line before the tags in a doc comment

Missing parameter comment

     * @return Collection|RoleModel[]

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

     */
    public function allThroughPosition(\BristolSU\ControlDB\Contracts\Models\Position $position): Collection
    {
        return \BristolSU\ControlDB\Models\Role::where('position_id', $position->id())->get();
    }

    /**
     * Paginate through all the roles
     *
     * @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|RoleModel[]
     */
    public function paginate(int $page, int $perPage): Collection
    {
        return \BristolSU\ControlDB\Models\Role::paginate($perPage, ['*'], 'page', $page)->getCollection();
    }

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

The expression return BristolSU\ControlDB\Models\Role::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 role model
     *
     * @param int $id

Missing parameter comment

     * @param int $positionId

Missing parameter comment

     * @param int $groupId

Missing parameter comment

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

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

     */
    public function update(int $id, int $positionId, int $groupId, int $dataProviderId): RoleModel
    {
        $role = $this->getById($id)->fill(['position_id' => $positionId, 'group_id' => $groupId, 'data_provider_id' => $dataProviderId]);
        $role->save();
        return $role;
    }
}