Completed
Push — master ( 98cd2e...56265b )
by Thomas
09:01
created

AbstractHtmlResponseGenerator::getTemplateFolder()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 1
Metric Value
c 1
b 0
f 1
dl 0
loc 3
rs 10
cc 1
eloc 2
nc 1
nop 0
1
<?php
2
namespace keeko\tools\generator\response;
3
4
use keeko\framework\schema\ActionSchema;
5
use keeko\tools\generator\AbstractResponseGenerator;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, keeko\tools\generator\re...stractResponseGenerator.

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...
6
7
class AbstractHtmlResponseGenerator extends AbstractResponseGenerator {
8
	
9
	protected function getTemplateFolder() {
10
		return 'response/html';
11
	}
12
	
13
	/**
14
	 * Generates a html response class for the given action
15
	 *
16
	 * @param ActionSchema $action
17
	 * @return PhpClass
18
	 */
19
	public function generate(ActionSchema $action) {
20
		return $this->doGenerate($action, 'html');
21
	}
22
}