App\Controller\Api\ApiController

Complexity

Total Complexity

3

Size/Duplication

Total Lines	138
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	imagesIndex()	0	27	1
A	wanderIndex()	0	40	1
A	wandersShow()	0	32	1

<?php

namespace App\Controller\Api;

use App\Entity\Wander;
use App\Repository\ImageRepository;
use App\Repository\WanderRepository;
use App\Service\SettingsService;
use Knp\Component\Pager\Paginator;
use Knp\Component\Pager\PaginatorInterface;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Component\Routing\RouterInterface;
use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;

/**
 * @Route("/api/", name="api_")
 */
class ApiController extends AbstractController
{
    /**
     *
     * API: Wander list. Returns a basic list of wanders.
     *
     * @Route(
     *  "wanders",
     *  name="wanders_index",
     *  methods={"GET"},
     *  format="json",
     *  condition="'application/json' in request.getAcceptableContentTypes()"
     * )
     */
    public function wanderIndex(
        Request $request,

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

        WanderRepository $wanderRepository,
        PaginatorInterface $paginator,

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

        RouterInterface $router
        ): Response
    {
        $wanders = $wanderRepository
            ->standardQueryBuilder()
            ->orderBy('w.startTime', 'asc')
            ->getQuery()
            ->execute();

        // It's nicer for our JavaScript to be handed the Wander URI on a plate, so we add it
        // to the returned JSON.
        $contentUrlCallback = function ($innerObject, $outerObject, string $attributeName, string $format = null, array $context = []) use ($router) {

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

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

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

            return $router->generate(
                'wanders_show',
                ['id' => $outerObject->getId()]
            );
        };

        $response = $this->json(
            $wanders,
            Response::HTTP_OK,
            [],
            [
                'groups' => 'wander:list',
                AbstractNormalizer::CALLBACKS => [
                    'contentUrl' => $contentUrlCallback,
                ],
            ]
        );

        $response
            ->setPublic()
            ->setSharedMaxAge(3600)
            ->setMaxAge(3600);

        return $response;
    }

    /**
     * @Route(
     *  "wanders/{id}",
     *  name="wanders_show",
     *  methods={"GET"},
     *  format="json",
     *  condition="'application/json' in request.getAcceptableContentTypes()"
     * )
     */
    public function wandersShow(
        Request $request,

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

        Wander $wander,
        RouterInterface $router
    ): Response {
        // It's nicer for our JavaScript to be handed the Wander URI on a plate, so we add it
        // to the returned JSON.
        $contentUrlCallback = function ($innerObject, $outerObject, string $attributeName, string $format = null, array $context = []) use ($router) {

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

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

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

            return $router->generate(
                'wanders_show',
                ['id' => $outerObject->getId()]
            );
        };

        $response = $this->json(
            $wander,
            Response::HTTP_OK,
            [],
            [
                'groups' => 'wander:item',
                AbstractNormalizer::CALLBACKS => [
                    'contentUrl' => $contentUrlCallback,
                ],
            ]
        );

        $response
            ->setPublic()
            ->setSharedMaxAge(3600)
            ->setMaxAge(3600);

        return $response;
    }

    /**
     *
     * API: Image list. Returns a basic list of images.
     *
     * @Route(
     *  "images",
     *  name="images_index",
     *  methods={"GET"},
     *  format="json",
     *  condition="'application/json' in request.getAcceptableContentTypes()"
     * )
     */
    public function imagesIndex(
        ImageRepository $imageRepository
    ): Response
    {
        $results = $imageRepository
            ->standardQueryBuilder()
            ->where('i.latlng IS NOT NULL')
            ->getQuery()
            ->execute();

        $response = $this->json(
            $results,
            Response::HTTP_OK,
            [],
            [
                'groups' => 'image:list',
            ]
        );

        $response
            ->setPublic()
            ->setSharedMaxAge(3600)
            // It's only an experiment, and it's slow to calculate, especially as it's nearly
            // a megabyte response on the live site. Keep it in shared cache for a *long* time.
            ->setMaxAge(43200);

        return $response;
    }
}