Test Failed
Push — master ( e3c39f...fe570d )
by Mihail
07:20
created

ApiController::setJsonHeader()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 3
rs 10
c 0
b 0
f 0
cc 1
eloc 1
nc 1
nop 0
1
<?php
2
3
namespace Extend\Core\Arch;
4
5
use Ffcms\Core\App;
6
use Ffcms\Core\Arch\Controller;
0 ignored issues
show
Bug introduced by Mihail
This use statement conflicts with another class in this namespace, Extend\Core\Arch\Controller. Consider defining an alias.

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...
7
8
/**
9
 * Class ApiController. Native controller to extend it by apps api controllers
10
 * @package Extend\Core\Arch
11
 */
12
class ApiController extends Controller
13
{
14
15
    /**
16
     * ApiController constructor. Disable global layout for api responses
17
     */
18
    public function __construct()
19
    {
20
        $this->layout = null;
0 ignored issues
show
Bug Best Practice introduced by Mihail
The property layout does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.
Loading history...
21
        parent::__construct();
22
    }
23
24
    /**
25
     * Set json header to http transport
26
     */
27
    public function setJsonHeader()
28
    {
29
        $this->response->headers->set('Content-Type', 'application/json');
30
    }
31
}
32