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

Controllers/Api/Requirements/Post/Response.php (1 issue)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

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\Requirements\Post;
15
16
use Cog\Contracts\Paket\Job\Entities\Job as JobContract;
17
use Cog\Contracts\Paket\Requirement\Entities\Requirement as RequirementContract;
18
use Illuminate\Contracts\Support\Responsable as ResponsableContract;
19
use Illuminate\Http\JsonResponse;
20
use Illuminate\Http\Request;
0 ignored issues
show
This use statement conflicts with another class in this namespace, Cog\Laravel\Paket\Http\C...quirements\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...
21
22 View Code Duplication
final class Response implements ResponsableContract
23
{
24
    private $requirement;
25
26
    private $job;
27
28
    public function __construct(RequirementContract $requirement, JobContract $job)
29
    {
30
        $this->requirement = $requirement;
31
        $this->job = $job;
32
    }
33
34
    /**
35
     * Create an HTTP response that represents the object.
36
     *
37
     * @param \Illuminate\Http\Request $request
38
     * @return \Symfony\Component\HttpFoundation\Response
39
     */
40
    public function toResponse($request)
41
    {
42
        return $this->toJson($request);
43
    }
44
45
    private function toJson(Request $request): JsonResponse
46
    {
47
        $jobUrl = route('paket.api.jobs.get', $this->job->getId());
48
49
        $data = [
50
            'data' => [
51
                'type' => 'CogPaketJob',
52
                'id' => $this->job->getId(),
53
                'attributes' => [
54
                    'status' => 'Shell command execution',
55
                ],
56
                'links' => [
57
                    'self' => $jobUrl,
58
                ],
59
            ],
60
        ];
61
62
        return response()->json($data, 202, [
63
            'Content-Location' => $jobUrl,
64
        ]);
65
    }
66
}
67