aboutsummaryrefslogtreecommitdiff
path: root/lib/classes/JsonApi/JsonApiController.php
blob: 645d4041dc17d1026630f710cbcd0d60f2df4b19 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
<?php

namespace JsonApi;

use JsonApi\JsonApiIntegration\JsonApiTrait;
use Psr\Container\ContainerInterface;

use Neomerx\JsonApi\Contracts\Http\Headers\HeadersCheckerInterface;
use Neomerx\JsonApi\Contracts\Http\Headers\HeaderParametersInterface;

/**
 * Ein JsonApiController ist die einfachste Möglichkeit, eine eigene
 * JSON-API-Route zu erstellen.
 *
 * Dazu erstellt man eine Unterklasse von JsonApiController und kann
 * darin __invoke oder andere Methoden definieren und diese in der
 * RouteMap registrieren.
 *
 * Wenn man auf den JsonApiController verzichten möchte, muss man den
 * JsonApiTrait in seiner eigenen Lösung einbinden und außerdem den
 * Dependency Container als Instanzvariabel $this->container eintragen
 * und die Methode JsonApiTrait::initJsonApiSupport aufrufen.
 *
 * Diese Klasse hier übernimmt all diese Aufgaben selbst.
 *
 * @see \JsonApi\JsonApiIntegration\JsonApiTrait
 * @see \JsonApi\RouteMap
 */
class JsonApiController
{
    use JsonApiTrait;

    /**
     * Der Konstruktor.
     *
     * @param ContainerInterface $container der Dependency Container
     */
    public function __construct(ContainerInterface $container)
    {
        $this->container = $container;
        $this->initJsonApiSupport($container);

        $headerChecker = $this->container[HeadersCheckerInterface::class];
        $headerChecker->checkHeaders($this->container[HeaderParametersInterface::class]);
    }
}