1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* phpDocumentor |
4
|
|
|
* |
5
|
|
|
* PHP Version 5.3 |
6
|
|
|
* |
7
|
|
|
* @copyright 2010-2018 Mike van Riel / Naenius (http://www.naenius.com) |
8
|
|
|
* @license http://www.opensource.org/licenses/mit-license.php MIT |
9
|
|
|
* @link http://phpdoc.org |
10
|
|
|
*/ |
11
|
|
|
|
12
|
|
|
namespace phpDocumentor\Transformer\Router\UrlGenerator; |
13
|
|
|
|
14
|
|
|
use Mockery as m; |
15
|
|
|
use Mockery\Adapter\Phpunit\MockeryTestCase; |
16
|
|
|
use phpDocumentor\Descriptor\ConstantDescriptor as ConstantDescriptorAlias; |
17
|
|
|
use phpDocumentor\Descriptor\FileDescriptor as FileDescriptorAlias; |
18
|
|
|
use Symfony\Component\Routing\Generator\UrlGeneratorInterface; |
|
|
|
|
19
|
|
|
|
20
|
|
|
/** |
21
|
|
|
* Test for the ConstantDescriptor URL Generator with the Standard Router |
22
|
|
|
* @coversDefaultClass \phpDocumentor\Transformer\Router\UrlGenerator\ConstantDescriptor |
23
|
|
|
*/ |
24
|
|
|
class ConstantDescriptorTest extends MockeryTestCase |
25
|
|
|
{ |
26
|
|
|
/** |
27
|
|
|
* @covers ::__construct |
28
|
|
|
* @covers ::__invoke |
29
|
|
|
* @covers ::generateUrlForGlobalConstant |
30
|
|
|
* @uses \phpDocumentor\Transformer\Router\UrlGenerator\QualifiedNameToUrlConverter::fromNamespace |
31
|
|
|
*/ |
32
|
|
|
public function testGenerateUrlForGlobalConstants(): void |
33
|
|
|
{ |
34
|
|
|
// Arrange |
35
|
|
|
$expected = '/namespaces/My.Space.html#constant_myConstant'; |
36
|
|
|
$urlGenerator = m::mock(UrlGeneratorInterface::class); |
37
|
|
|
$urlGenerator->shouldReceive('generate')->andReturn($expected); |
|
|
|
|
38
|
|
|
$converter = new QualifiedNameToUrlConverter(); |
39
|
|
|
|
40
|
|
|
$fixture = new ConstantDescriptor($urlGenerator, $converter); |
|
|
|
|
41
|
|
|
$constantDescriptorMock = m::mock(ConstantDescriptorAlias::class); |
42
|
|
|
$constantDescriptorMock |
43
|
|
|
->shouldReceive('getParent')->andReturn(m::mock(FileDescriptorAlias::class)); |
44
|
|
|
$constantDescriptorMock->shouldReceive('getNamespace')->andReturn('My\\Space'); |
45
|
|
|
$constantDescriptorMock->shouldReceive('getName')->andReturn('myConstant'); |
46
|
|
|
|
47
|
|
|
// Act |
48
|
|
|
$result = $fixture($constantDescriptorMock); |
49
|
|
|
|
50
|
|
|
// Assert |
51
|
|
|
$this->assertSame($expected, $result); |
52
|
|
|
} |
53
|
|
|
|
54
|
|
|
/** |
55
|
|
|
* @covers ::__construct |
56
|
|
|
* @covers ::__invoke |
57
|
|
|
* @covers ::generateUrlForGlobalConstant |
58
|
|
|
* @uses \phpDocumentor\Transformer\Router\UrlGenerator\QualifiedNameToUrlConverter::fromNamespace |
59
|
|
|
*/ |
60
|
|
|
public function testGenerateUrlForGlobalConstantsAtRootNamespace(): void |
61
|
|
|
{ |
62
|
|
|
// Arrange |
63
|
|
|
$expected = '/namespaces/default.html#constant_myConstant'; |
64
|
|
|
$urlGenerator = m::mock(UrlGeneratorInterface::class); |
65
|
|
|
$urlGenerator->shouldReceive('generate')->andReturn($expected); |
|
|
|
|
66
|
|
|
$converter = new QualifiedNameToUrlConverter(); |
67
|
|
|
|
68
|
|
|
$fixture = new ConstantDescriptor($urlGenerator, $converter); |
|
|
|
|
69
|
|
|
$constantDescriptorMock = m::mock('phpDocumentor\Descriptor\ConstantDescriptor'); |
70
|
|
|
$constantDescriptorMock->shouldReceive('getParent')->andReturnNull(); |
71
|
|
|
$constantDescriptorMock->shouldReceive('getNamespace')->andReturn('\\'); |
72
|
|
|
$constantDescriptorMock->shouldReceive('getName')->andReturn('myConstant'); |
73
|
|
|
|
74
|
|
|
// Act |
75
|
|
|
$result = $fixture($constantDescriptorMock); |
76
|
|
|
|
77
|
|
|
// Assert |
78
|
|
|
$this->assertSame($expected, $result); |
79
|
|
|
} |
80
|
|
|
|
81
|
|
|
/** |
82
|
|
|
* @covers ::__invoke |
83
|
|
|
* @covers ::generateUrlForClassConstant |
84
|
|
|
* @uses \phpDocumentor\Transformer\Router\UrlGenerator\QualifiedNameToUrlConverter::fromClass |
85
|
|
|
*/ |
86
|
|
|
public function testGenerateUrlForClassConstants(): void |
87
|
|
|
{ |
88
|
|
|
// Arrange |
89
|
|
|
$expected = '/classes/My.Space.Class.html#constant_myConstant'; |
90
|
|
|
$urlGenerator = m::mock(UrlGeneratorInterface::class); |
91
|
|
|
$urlGenerator->shouldReceive('generate')->andReturn($expected); |
|
|
|
|
92
|
|
|
$converter = new QualifiedNameToUrlConverter(); |
93
|
|
|
$fixture = new ConstantDescriptor($urlGenerator, $converter); |
|
|
|
|
94
|
|
|
|
95
|
|
|
$classDescriptorMock = m::mock('phpDocumentor\Descriptor\ClassDescriptor'); |
96
|
|
|
$classDescriptorMock |
97
|
|
|
->shouldReceive('getFullyQualifiedStructuralElementName') |
98
|
|
|
->andReturn('My\\Space\\Class'); |
99
|
|
|
|
100
|
|
|
$constantDescriptorMock = m::mock('phpDocumentor\Descriptor\ConstantDescriptor'); |
101
|
|
|
$constantDescriptorMock->shouldReceive('getParent')->andReturn($classDescriptorMock); |
102
|
|
|
$constantDescriptorMock->shouldReceive('getName')->andReturn('myConstant'); |
103
|
|
|
|
104
|
|
|
// Act |
105
|
|
|
$result = $fixture($constantDescriptorMock); |
106
|
|
|
|
107
|
|
|
// Assert |
108
|
|
|
$this->assertSame($expected, $result); |
109
|
|
|
} |
110
|
|
|
} |
111
|
|
|
|
Let’s assume that you have a directory layout like this:
and let’s assume the following content of
Bar.php
:If both files
OtherDir/Foo.php
andSomeDir/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 beforeOtherDir/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: