Version 1
[yaffs-website] / web / core / tests / Drupal / Tests / Core / Entity / EntityLinkTest.php
1 <?php
2
3 namespace Drupal\Tests\Core\Entity;
4
5 use Drupal\Core\DependencyInjection\ContainerBuilder;
6 use Drupal\Core\Language\Language;
7 use Drupal\Core\Link;
8 use Drupal\Tests\UnitTestCase;
9
10 /**
11  * @coversDefaultClass \Drupal\Core\Entity\Entity
12  * @group Entity
13  */
14 class EntityLinkTest extends UnitTestCase {
15
16   /**
17    * The mocked entity manager.
18    *
19    * @var \Drupal\Core\Entity\EntityManagerInterface|\PHPUnit_Framework_MockObject_MockObject
20    */
21   protected $entityManager;
22
23   /**
24    * The tested link generator.
25    *
26    * @var \Drupal\Core\Utility\LinkGeneratorInterface|\PHPUnit_Framework_MockObject_MockObject
27    */
28   protected $linkGenerator;
29
30   /**
31    * The mocked language manager.
32    *
33    * @var \Drupal\Core\Language\LanguageManagerInterface|\PHPUnit_Framework_MockObject_MockObject
34    */
35   protected $languageManager;
36
37   /**
38    * {@inheritdoc}
39    */
40   protected function setUp() {
41     parent::setUp();
42
43     $this->entityManager = $this->getMock('Drupal\Core\Entity\EntityManagerInterface');
44     $this->linkGenerator = $this->getMock('Drupal\Core\Utility\LinkGeneratorInterface');
45     $this->languageManager = $this->getMock('Drupal\Core\Language\LanguageManagerInterface');
46
47     $container = new ContainerBuilder();
48     $container->set('entity.manager', $this->entityManager);
49     $container->set('link_generator', $this->linkGenerator);
50     $container->set('language_manager', $this->languageManager);
51     \Drupal::setContainer($container);
52   }
53
54   /**
55    * Tests for the Entity::link() method
56    *
57    * @covers ::link
58    *
59    * @dataProvider providerTestLink
60    */
61   public function testLink($entity_label, $link_text, $expected_text, $link_rel = 'canonical', array $link_options = []) {
62     $language = new Language(['id' => 'es']);
63     $link_options += ['language' => $language];
64     $this->languageManager->expects($this->any())
65       ->method('getLanguage')
66       ->with('es')
67       ->willReturn($language);
68
69     $route_name_map = [
70       'canonical' => 'entity.test_entity_type.canonical',
71       'edit-form' => 'entity.test_entity_type.edit_form',
72     ];
73     $route_name = $route_name_map[$link_rel];
74     $entity_id = 'test_entity_id';
75     $entity_type_id = 'test_entity_type';
76     $expected = '<a href="/test_entity_type/test_entity_id">' . $expected_text . '</a>';
77
78     $entity_type = $this->getMock('Drupal\Core\Entity\EntityTypeInterface');
79     $entity_type->expects($this->once())
80       ->method('getLinkTemplates')
81       ->willReturn($route_name_map);
82     $entity_type->expects($this->any())
83       ->method('getKey')
84       ->willReturnMap([
85         ['label', 'label'],
86         ['langcode', 'langcode'],
87       ]);
88
89     $this->entityManager
90       ->expects($this->any())
91       ->method('getDefinition')
92       ->with($entity_type_id)
93       ->will($this->returnValue($entity_type));
94
95     /** @var \Drupal\Core\Entity\Entity $entity */
96     $entity = $this->getMockForAbstractClass('Drupal\Core\Entity\Entity', [
97       ['id' => $entity_id, 'label' => $entity_label, 'langcode' => 'es'],
98       $entity_type_id,
99     ]);
100
101     $expected_link = Link::createFromRoute(
102       $expected_text,
103       $route_name,
104       [$entity_type_id => $entity_id],
105       ['entity_type' => $entity_type_id, 'entity' => $entity] + $link_options
106     )->setLinkGenerator($this->linkGenerator);
107
108     $this->linkGenerator->expects($this->once())
109       ->method('generateFromLink')
110       ->with($this->equalTo($expected_link))
111       ->willReturn($expected);
112
113     $this->assertSame($expected, $entity->link($link_text, $link_rel, $link_options));
114   }
115
116   /**
117    * Tests for the Entity::toLink() method
118    *
119    * @covers ::toLink
120    *
121    * @dataProvider providerTestLink
122    */
123   public function testToLink($entity_label, $link_text, $expected_text, $link_rel = 'canonical', array $link_options = []) {
124     $language = new Language(['id' => 'es']);
125     $link_options += ['language' => $language];
126     $this->languageManager->expects($this->any())
127       ->method('getLanguage')
128       ->with('es')
129       ->willReturn($language);
130
131     $route_name_map = [
132       'canonical' => 'entity.test_entity_type.canonical',
133       'edit-form' => 'entity.test_entity_type.edit_form',
134     ];
135     $route_name = $route_name_map[$link_rel];
136     $entity_id = 'test_entity_id';
137     $entity_type_id = 'test_entity_type';
138     $expected = '<a href="/test_entity_type/test_entity_id">' . $expected_text . '</a>';
139
140     $entity_type = $this->getMock('Drupal\Core\Entity\EntityTypeInterface');
141     $entity_type->expects($this->once())
142       ->method('getLinkTemplates')
143       ->willReturn($route_name_map);
144     $entity_type->expects($this->any())
145       ->method('getKey')
146       ->willReturnMap([
147         ['label', 'label'],
148         ['langcode', 'langcode'],
149       ]);
150
151     $this->entityManager
152       ->expects($this->any())
153       ->method('getDefinition')
154       ->with($entity_type_id)
155       ->will($this->returnValue($entity_type));
156
157     /** @var \Drupal\Core\Entity\Entity $entity */
158     $entity = $this->getMockForAbstractClass('Drupal\Core\Entity\Entity', [
159       ['id' => $entity_id, 'label' => $entity_label, 'langcode' => 'es'],
160       $entity_type_id,
161     ]);
162
163     $expected_link = Link::createFromRoute(
164       $expected_text,
165       $route_name,
166       [$entity_type_id => $entity_id],
167       ['entity_type' => $entity_type_id, 'entity' => $entity] + $link_options
168     );
169
170     $result_link = $entity->toLink($link_text, $link_rel, $link_options);
171     $this->assertEquals($expected_link, $result_link);
172   }
173
174   /**
175    * Provides test data for testLink().
176    */
177   public function providerTestLink() {
178     $data = [];
179     $data[] = [
180       'some_entity_label',
181       'qwerqwer',
182       'qwerqwer',
183     ];
184     $data[] = [
185       'some_entity_label',
186       NULL,
187       'some_entity_label',
188     ];
189     $data[] = [
190       'some_entity_label',
191       '0',
192       '0',
193     ];
194     $data[] = [
195       'some_entity_label',
196       'qwerqwer',
197       'qwerqwer',
198       'edit-form',
199     ];
200     $data[] = [
201       'some_entity_label',
202       'qwerqwer',
203       'qwerqwer',
204       'edit-form',
205     ];
206     $data[] = [
207       'some_entity_label',
208       'qwerqwer',
209       'qwerqwer',
210       'edit-form',
211       ['foo' => 'qwer'],
212     ];
213     return $data;
214   }
215
216 }