Completed
Push — master ( cdbec6...220d3b )
by Anton
01:25
created

Response::toJson()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 21

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 21
rs 9.584
c 0
b 0
f 0
cc 1
nc 1
nop 1
1
<?php
2
3
/*
4
 * This file is part of Laravel Paket.
5
 *
6
 * (c) Anton Komarev <[email protected]>
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
declare(strict_types=1);
13
14
namespace Cog\Laravel\Paket\Http\Controllers\Api\Jobs\Post;
15
16
use Cog\Contracts\Paket\Job\Entities\Job as JobContract;
17
use Illuminate\Contracts\Support\Responsable as ResponsableContract;
18
use Illuminate\Http\JsonResponse;
19
use Illuminate\Http\Request;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, Cog\Laravel\Paket\Http\C...s\Api\Jobs\Post\Request.

Let’s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let’s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
20
21
final class Response implements ResponsableContract
22
{
23
    private $job;
24
25
    public function __construct(JobContract $job)
26
    {
27
        $this->job = $job;
28
    }
29
30
    /**
31
     * Create an HTTP response that represents the object.
32
     *
33
     * @param \Illuminate\Http\Request $request
34
     * @return \Symfony\Component\HttpFoundation\Response
35
     */
36
    public function toResponse($request)
37
    {
38
        return $this->toJson($request);
39
    }
40
41
    private function toJson(Request $request): JsonResponse
42
    {
43
        $jobUrl = route('paket.api.jobs.get', $this->job->getId());
44
45
        $data = [
46
            'data' => [
47
                'type' => 'CogPaketJob',
48
                'id' => $this->job->getId(),
49
                'attributes' => [
50
                    'status' => 'Shell command execution',
51
                ],
52
                'links' => [
53
                    'self' => $jobUrl,
54
                ],
55
            ],
56
        ];
57
58
        return response()->json($data, 202, [
59
            'Content-Location' => $jobUrl,
60
        ]);
61
    }
62
}
63