BristolSU\ControlDB\Http\Controllers\Position\PositionController

Complexity

Total Complexity

14

Size/Duplication

Total Lines	112
Duplicated Lines	0 %

Test Coverage

Coverage

68.28%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	store()	0	13	3
A	index()	0	8	1
A	show()	0	3	1
A	search()	0	19	5
A	update()	0	16	3
A	destroy()	0	3	1

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Http\Controllers\Position;

use BristolSU\ControlDB\Http\Controllers\Controller;
use BristolSU\ControlDB\Http\Requests\Api\Position\StorePositionRequest;
use BristolSU\ControlDB\Http\Requests\Api\Position\UpdatePositionRequest;
use BristolSU\ControlDB\Contracts\Models\Position;
use BristolSU\ControlDB\Contracts\Repositories\DataPosition as DataPositionRepository;
use BristolSU\ControlDB\Contracts\Repositories\Position as PositionRepository;
use Illuminate\Http\Request;
use Illuminate\Pagination\LengthAwarePaginator;
use Illuminate\Support\Collection;

/**
 * Handles a position model
 */

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 PositionController extends Controller
{

    /**
     * Get all positions
     *
     * @param Request $request

Missing parameter comment

Expected 12 spaces after parameter type; 1 found

     * @param PositionRepository $positionRepository

Missing parameter comment

     * @return LengthAwarePaginator

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

     */
    public function index(Request $request, PositionRepository $positionRepository)
    {
        $perPage = $request->input('per_page', 10);
        $page = $request->input('page', 1);

        return $this->paginationResponse(
            $positionRepository->paginate($page, $perPage),
            $positionRepository->count()
        );
    }

    public function search(Request $request, PositionRepository $positionRepository, DataPositionRepository $dataPositionRepository)

The parameter $positionRepository is not used and could be removed.

Missing doc comment for function search()

    {

        $search = [];
        if($request->has('name')) {

Expected "if (...) {\n"; found "if(...) {\n"

            $search['name'] = $request->input('name');
        }
        if($request->has('description')) {

Expected "if (...) {\n"; found "if(...) {\n"

            $search['description'] = $request->input('description');
        }
        $dataPositions = $dataPositionRepository->getAllWhere($search);
        $positions = new Collection();
        foreach($dataPositions as $dataPosition) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            $position = $dataPosition->position();
            if($position !== null) {

Expected "if (...) {\n"; found "if(...) {\n"

                $positions->push($position);
            }
        }
        return $this->paginate($positions);
    }

    /**
     * Return information about a single position
     * 
     * @param Position $position

Missing parameter comment

     * @return Position

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

     */
    public function show(Position $position)
    {
    	return $position;

Line indented incorrectly; expected at least 8 spaces, found 5

    }

    /**
     * Create a new position
     * 
     * @param StorePositionRequest $request

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     * @param PositionRepository $positionRepository

Missing parameter comment

Expected 5 spaces after parameter type; 1 found

     * @param DataPositionRepository $dataPositionRepository

Missing parameter comment

     * @return Position

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

     */
    public function store(StorePositionRequest $request, PositionRepository $positionRepository, DataPositionRepository $dataPositionRepository)
    {
        $dataPosition = $dataPositionRepository->create(
            $request->input('name'),
            $request->input('description')
        );
        foreach($dataPosition->getAdditionalAttributes() as $additionalAttribute) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            if($request->has($additionalAttribute)) {

Expected "if (...) {\n"; found "if(...) {\n"

                $dataPosition->saveAdditionalAttribute($additionalAttribute, $request->input($additionalAttribute));
            }
        }

        return $positionRepository->create($dataPosition->id());
    }

    /**
     * Update a position
     * 
     * @param Position $position

Missing parameter comment

Expected 15 spaces after parameter type; 1 found

     * @param UpdatePositionRequest $request

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param PositionRepository $positionRepository

Missing parameter comment

Expected 5 spaces after parameter type; 1 found

Doc comment for parameter $positionRepository does not match actual variable name $dataPositionRepository

     * @param DataPositionRepository $dataPositionRepository

Missing parameter comment

Superfluous parameter comment

     * @return Position

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

     */
    public function update(Position $position, UpdatePositionRequest $request, DataPositionRepository $dataPositionRepository)
    {
        $dataPosition = $position->data();
        $dataPositionRepository->update(
            $dataPosition->id(),
            $request->input('name', $dataPosition->name()),
            $request->input('description', $dataPosition->description())
        );
        
        foreach($dataPosition->getAdditionalAttributes() as $additionalAttribute) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            if($request->has($additionalAttribute)) {

Expected "if (...) {\n"; found "if(...) {\n"

                $dataPosition->saveAdditionalAttribute($additionalAttribute, $request->input($additionalAttribute));
            }
        }
        
        return $position;
    }

    /**
     * Delete a position
     * 
     * @param Position $position

Missing parameter comment

Expected 11 spaces after parameter type; 1 found

     * @param PositionRepository $positionRepository

Missing parameter comment

     */

Missing @return tag in function comment

    public function destroy(Position $position, PositionRepository $positionRepository)
    {
        $positionRepository->delete((int) $position->id());
    }

}