Skip to content

Commit 2e4349b

Browse files
Jelle-Samitaibu
Jelle-S
authored and
amitaibu
committedDec 17, 2014
Set language in constructor of \RestfulBase, with tests.
·
7.x-2.167.x-1.0-rc3
1 parent 61ab5cf commit 2e4349b

13 files changed

+338
-13
lines changed
 

‎plugins/restful/RestfulBase.php

+34-1
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,13 @@ abstract class RestfulBase extends \RestfulPluginBase implements \RestfulInterfa
7575
*/
7676
protected $valueMetadata = array();
7777

78+
/**
79+
* Determines the language of the items that should be returned.
80+
*
81+
* @var string
82+
*/
83+
protected $langcode;
84+
7885
/**
7986
* Static cache controller.
8087
*
@@ -211,6 +218,25 @@ public function getRequest() {
211218
return $this->request;
212219
}
213220

221+
/**
222+
* Get the language code.
223+
*
224+
* @return string
225+
*/
226+
public function getLangCode() {
227+
return $this->langcode;
228+
}
229+
230+
/**
231+
* Sets the language code.
232+
*
233+
* @param string $langcode
234+
* The language code.
235+
*/
236+
public function setLangCode($langcode) {
237+
$this->langcode = $langcode;
238+
}
239+
214240
/**
215241
* Set the request array.
216242
*
@@ -345,14 +371,21 @@ public function getRateLimitManager() {
345371
* @param DrupalCacheInterface $cache_controller
346372
* (optional) Injected cache backend.
347373
*/
348-
public function __construct(array $plugin, \RestfulAuthenticationManager $auth_manager = NULL, \DrupalCacheInterface $cache_controller = NULL) {
374+
public function __construct(array $plugin, \RestfulAuthenticationManager $auth_manager = NULL, \DrupalCacheInterface $cache_controller = NULL, $langcode = NULL) {
349375
parent::__construct($plugin);
350376
$this->authenticationManager = $auth_manager ? $auth_manager : new \RestfulAuthenticationManager();
351377
$this->cacheController = $cache_controller ? $cache_controller : $this->newCacheObject();
352378
if ($rate_limit = $this->getPluginKey('rate_limit')) {
353379
$this->setRateLimitManager(new \RestfulRateLimitManager($this->getPluginKey('resource'), $rate_limit));
354380
}
355381
$this->staticCache = new \RestfulStaticCacheController();
382+
if (is_null($langcode)) {
383+
global $language;
384+
$this->langcode = $language->language;
385+
}
386+
else {
387+
$this->langcode = $langcode;
388+
}
356389
}
357390

358391
/**

‎plugins/restful/RestfulDataProviderCToolsPlugins.php

+4-2
Original file line numberDiff line numberDiff line change
@@ -173,9 +173,11 @@ protected function sortMultiCompare($value1, $value2) {
173173
* (optional) Injected authentication manager.
174174
* @param DrupalCacheInterface $cache_controller
175175
* (optional) Injected cache backend.
176+
* @param string $language
177+
* (optional) The language to return items in.
176178
*/
177-
public function __construct(array $plugin, \RestfulAuthenticationManager $auth_manager = NULL, \DrupalCacheInterface $cache_controller = NULL) {
178-
parent::__construct($plugin, $auth_manager, $cache_controller);
179+
public function __construct(array $plugin, \RestfulAuthenticationManager $auth_manager = NULL, \DrupalCacheInterface $cache_controller = NULL, $language = NULL) {
180+
parent::__construct($plugin, $auth_manager, $cache_controller, $language);
179181

180182
// Validate keys exist in the plugin's "data provider options".
181183
$required_keys = array(

‎plugins/restful/RestfulDataProviderDbQuery.php

+4-2
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,11 @@ public function setTableName($table_name) {
7777
* (optional) Injected authentication manager.
7878
* @param DrupalCacheInterface $cache_controller
7979
* (optional) Injected cache backend.
80+
* @param string $language
81+
* (optional) The language to return items in.
8082
*/
81-
public function __construct(array $plugin, \RestfulAuthenticationManager $auth_manager = NULL, \DrupalCacheInterface $cache_controller = NULL) {
82-
parent::__construct($plugin, $auth_manager, $cache_controller);
83+
public function __construct(array $plugin, \RestfulAuthenticationManager $auth_manager = NULL, \DrupalCacheInterface $cache_controller = NULL, $language = NULL) {
84+
parent::__construct($plugin, $auth_manager, $cache_controller, $language);
8385

8486
// Validate keys exist in the plugin's "data provider options".
8587
$required_keys = array(

‎plugins/restful/RestfulDataProviderEFQ.php

+4-2
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,11 @@ public function getEntityType() {
4848
* (optional) Injected authentication manager.
4949
* @param DrupalCacheInterface $cache_controller
5050
* (optional) Injected cache backend.
51+
* @param string $language
52+
* (optional) The language to return items in.
5153
*/
52-
public function __construct(array $plugin, \RestfulAuthenticationManager $auth_manager = NULL, \DrupalCacheInterface $cache_controller = NULL) {
53-
parent::__construct($plugin, $auth_manager, $cache_controller);
54+
public function __construct(array $plugin, \RestfulAuthenticationManager $auth_manager = NULL, \DrupalCacheInterface $cache_controller = NULL, $language = NULL) {
55+
parent::__construct($plugin, $auth_manager, $cache_controller, $language);
5456
$this->entityType = $plugin['entity_type'];
5557
$this->bundle = $plugin['bundle'];
5658
}

‎plugins/restful/RestfulEntityBase.php

+1-2
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,6 @@ protected function getQueryResultForAutocomplete() {
268268
* {@inheritdoc}
269269
*/
270270
public function viewEntity($entity_id) {
271-
global $language;
272271
$request = $this->getRequest();
273272

274273
$cached_data = $this->getRenderedCache(array(
@@ -284,7 +283,7 @@ public function viewEntity($entity_id) {
284283
}
285284

286285
$wrapper = entity_metadata_wrapper($this->entityType, $entity_id);
287-
$wrapper->language($language->language);
286+
$wrapper->language($this->getLangCode());
288287
$values = array();
289288

290289
$limit_fields = !empty($request['fields']) ? explode(',', $request['fields']) : array();

‎plugins/restful/RestfulEntityBaseMultipleBundles.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ public static function controllersInfo() {
2727
);
2828
}
2929

30-
public function __construct(array $plugin, \RestfulAuthenticationManager $auth_manager = NULL, \DrupalCacheInterface $cache_controller = NULL) {
31-
parent::__construct($plugin);
30+
public function __construct(array $plugin, \RestfulAuthenticationManager $auth_manager = NULL, \DrupalCacheInterface $cache_controller = NULL, $language = NULL) {
31+
parent::__construct($plugin, $auth_manager, $cache_controller, $language);
3232

3333
if (!empty($plugin['bundles'])) {
3434
$this->bundles = $plugin['bundles'];

‎plugins/restful/RestfulFilesUpload.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ public static function controllersInfo() {
2727
* file size.
2828
* - "scheme": By default the default scheme (e.g. public, private) is used.
2929
*/
30-
public function __construct(array $plugin, \RestfulAuthenticationManager $auth_manager = NULL, \DrupalCacheInterface $cache_controller = NULL) {
31-
parent::__construct($plugin, $auth_manager, $cache_controller);
30+
public function __construct(array $plugin, \RestfulAuthenticationManager $auth_manager = NULL, \DrupalCacheInterface $cache_controller = NULL, $language = NULL) {
31+
parent::__construct($plugin, $auth_manager, $cache_controller, $language);
3232

3333
if (!$options = $this->getPluginKey('options')) {
3434
$options = array();

‎restful.info

+1
Original file line numberDiff line numberDiff line change
@@ -82,3 +82,4 @@ files[] = tests/RestfulSubResourcesCreateEntityTestCase.test
8282
files[] = tests/RestfulUpdateEntityCurlTestCase.test
8383
files[] = tests/RestfulUserLoginCookieTestCase.test
8484
files[] = tests/RestfulViewEntityTestCase.test
85+
files[] = tests/RestfulViewEntityMultiLingualTestCase.test

‎tests/RestfulViewEntityMultiLingualTestCase.test

+154
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
<?php
2+
3+
/**
4+
* @file
5+
* Contains RestfulViewEntityMultiLingualTestCase
6+
*/
7+
8+
class RestfulViewEntityMultiLingualTestCase extends RestfulCurlBaseTestCase {
9+
10+
/**
11+
* The user to run the tests as.
12+
*/
13+
protected $testUser;
14+
15+
public static function getInfo() {
16+
return array(
17+
'name' => 'View multilingual entity',
18+
'description' => 'Test the viewing of a multilingual entity.',
19+
'group' => 'Restful',
20+
);
21+
}
22+
23+
function setUp() {
24+
parent::setUp(
25+
'restful_example',
26+
'restful_test',
27+
'entityreference',
28+
'locale'
29+
);
30+
31+
$this->testUser = $this->drupalCreateUser(
32+
array(
33+
'administer languages',
34+
'access administration pages',
35+
'administer site configuration',
36+
)
37+
);
38+
require_once DRUPAL_ROOT . '/includes/locale.inc';
39+
$this->drupalLogin($this->testUser);
40+
$languages = language_list();
41+
if (!isset($languages['en'])) {
42+
locale_add_language('en', NULL, NULL, LANGUAGE_LTR, '', 'en');
43+
}
44+
if (!isset($languages['fr'])) {
45+
locale_add_language('fr', NULL, NULL, LANGUAGE_LTR, '', 'fr');
46+
}
47+
$this->addTestFields();
48+
}
49+
50+
/**
51+
* Add test fields.
52+
*/
53+
protected function addTestFields() {
54+
// Text - single.
55+
$field = array(
56+
'field_name' => 'text_single',
57+
'type' => 'text_long',
58+
'entity_types' => array('restful_test_translatable_entity'),
59+
'cardinality' => 1,
60+
'translatable' => TRUE,
61+
);
62+
field_create_field($field);
63+
64+
$instance = array(
65+
'field_name' => 'text_single',
66+
'bundle' => 'restful_test_translatable_entity',
67+
'entity_type' => 'restful_test_translatable_entity',
68+
'label' => t('Text single'),
69+
'settings' => array(
70+
'text_processing' => 0,
71+
),
72+
);
73+
field_create_instance($instance);
74+
// Text - multiple.
75+
$field = array(
76+
'field_name' => 'text_multiple',
77+
'type' => 'text_long',
78+
'entity_types' => array('restful_test_translatable_entity'),
79+
'cardinality' => FIELD_CARDINALITY_UNLIMITED,
80+
'translatable' => TRUE,
81+
);
82+
field_create_field($field);
83+
84+
$instance = array(
85+
'field_name' => 'text_multiple',
86+
'bundle' => 'restful_test_translatable_entity',
87+
'entity_type' => 'restful_test_translatable_entity',
88+
'label' => t('Text multiple'),
89+
'settings' => array(
90+
'text_processing' => 0,
91+
),
92+
);
93+
field_create_instance($instance);
94+
}
95+
96+
/**
97+
* Test viewing an entity with translatable fields.
98+
*/
99+
function testViewMultiLangualEntity() {
100+
$user = $this->drupalCreateUser();
101+
$values = array(
102+
'name' => 'restful_test_translatable_entity',
103+
'uid' => $user->uid,
104+
'label' => 'Test translation',
105+
);
106+
$entity = entity_create('restful_test_translatable_entity', $values);
107+
$wrapper = entity_metadata_wrapper('restful_test_translatable_entity', $entity);
108+
109+
$text1 = array(
110+
'en' => $this->randomName(),
111+
'fr' => $this->randomName(),
112+
);
113+
$text2 = array(
114+
'en' => $this->randomName(),
115+
'fr' => $this->randomName(),
116+
);
117+
118+
foreach (array('en', 'fr') as $langcode) {
119+
$wrapper->language($langcode);
120+
$wrapper->text_single->set($text1[$langcode]);
121+
$wrapper->text_multiple->set(array($text1[$langcode], $text2[$langcode]));
122+
}
123+
$wrapper->save();
124+
125+
$id = $entity->pid;
126+
foreach (array('en', 'fr') as $langcode) {
127+
$this->assertExpectedResult($langcode, $id, $text1[$langcode], $text2[$langcode]);
128+
}
129+
}
130+
131+
/**
132+
* Helper to test viewing an entity (GET method) in a certain language.
133+
*
134+
* @param string $langcode
135+
* The language to view the entity in.
136+
* @param int $id
137+
* The ID of the entity to test.
138+
* @param string $text1
139+
* The first expected string (text_single and text_multiple[0]).
140+
* @param string $text2
141+
* The second expected string (text_multiple[2]).
142+
*/
143+
private function assertExpectedResult($langcode, $id, $text1, $text2) {
144+
$handler = restful_get_restful_handler('restful_test_translatable_entity');
145+
// Explicitly set the langcode.
146+
$handler->setLangCode($langcode);
147+
$response = $handler->get($id);
148+
$result = $response[0];
149+
150+
$this->assertEqual(trim(strip_tags($result['text_single'])), $text1, 'Entity view has correct result for "text_single" in language "' . $langcode . '".');
151+
$this->assertEqual(trim(strip_tags($result['text_multiple'][0])), $text1, 'Entity view has correct result for the first value of "text_multiple" in language "' . $langcode . '".');
152+
$this->assertEqual(trim(strip_tags($result['text_multiple'][1])), $text2, 'Entity view has correct result for the second value of "text_multiple" in language "' . $langcode . '".');
153+
}
154+
}

‎tests/modules/restful_test/plugins/restful/restful_test_translatable_entity/1.0/RestfulTestTranslatableEntityResource__1_0.class.php

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?php
2+
3+
/**
4+
* @file
5+
* Contains RestfulTestTranslatableEntityResource__1_0.
6+
*/
7+
8+
class RestfulTestTranslatableEntityResource__1_0 extends RestfulTestMainResource {
9+
10+
/**
11+
* Overrides RestfulTestEntityTestsResource::publicFieldsInfo().
12+
*/
13+
public function publicFieldsInfo() {
14+
$public_fields = parent::publicFieldsInfo();
15+
16+
$public_fields['text_single'] = array(
17+
'property' => 'text_single',
18+
);
19+
20+
$public_fields['text_multiple'] = array(
21+
'property' => 'text_multiple',
22+
);
23+
24+
return $public_fields;
25+
}
26+
}

‎tests/modules/restful_test/plugins/restful/restful_test_translatable_entity/1.0/restful_test_translatable_entity__1_0.inc

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<?php
2+
3+
$plugin = array(
4+
'label' => t('Restful Test Translatable Entity'),
5+
'description' => t('Export Restful Test Translatable Entities.'),
6+
'resource' => 'restful_test_translatable_entity',
7+
'name' => 'restful_test_translatable_entity__1_0',
8+
'entity_type' => 'restful_test_translatable_entity',
9+
'bundle' => 'restful_test_translatable_entity',
10+
'class' => 'RestfulTestTranslatableEntityResource__1_0',
11+
);

‎tests/modules/restful_test/restful_test.install

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
<?php
2+
3+
/**
4+
* @file
5+
* Install, update and uninstall functions for the entity_test module.
6+
*/
7+
8+
/**
9+
* Implements hook_uninstall().
10+
*/
11+
function restful_test_uninstall() {
12+
field_attach_delete_bundle('restful_test_translatable_entity', 'restful_test_translatable_entity');
13+
}
14+
15+
/**
16+
* Implements hook_schema().
17+
*/
18+
function restful_test_schema() {
19+
$schema['restful_test_translatable_entity'] = array(
20+
'description' => 'Stores restful_test_translatable_entity items.',
21+
'fields' => array(
22+
'pid' => array(
23+
'type' => 'serial',
24+
'not null' => TRUE,
25+
'description' => 'Primary Key: Unique restful_test_translatable_entity item ID.',
26+
),
27+
'name' => array(
28+
'description' => 'The name of the restful_test_translatable_entity.',
29+
'type' => 'varchar',
30+
'length' => 32,
31+
'not null' => TRUE,
32+
'default' => '',
33+
),
34+
'uid' => array(
35+
'type' => 'int',
36+
'unsigned' => TRUE,
37+
'not null' => FALSE,
38+
'default' => NULL,
39+
'description' => "The {users}.uid of the associated user.",
40+
),
41+
'label' => array(
42+
'type' => 'varchar',
43+
'length' => 255,
44+
'not null' => TRUE,
45+
'default' => '',
46+
),
47+
),
48+
'indexes' => array(
49+
'uid' => array('uid'),
50+
),
51+
'foreign keys' => array(
52+
'uid' => array('users' => 'uid'),
53+
),
54+
'primary key' => array('pid'),
55+
);
56+
57+
return $schema;
58+
}

‎tests/modules/restful_test/restful_test.module

+37
Original file line numberDiff line numberDiff line change
@@ -433,3 +433,40 @@ function _restful_test_schema() {
433433
);
434434
return $schema;
435435
}
436+
437+
/**
438+
* Implements hook_entity_info().
439+
*/
440+
function restful_test_entity_info() {
441+
return array(
442+
'restful_test_translatable_entity' => array(
443+
'label' => t('Translatable Test Entity'),
444+
'plural label' => t('Translatable Test Entities'),
445+
'description' => t('An entity type used by the Restful tests.'),
446+
'entity class' => 'Entity',
447+
'controller class' => 'EntityAPIController',
448+
'base table' => 'restful_test_translatable_entity',
449+
'fieldable' => TRUE,
450+
'entity keys' => array(
451+
'id' => 'pid',
452+
'bundle' => 'name',
453+
'label' => 'label',
454+
),
455+
// Make use the class' label() and uri() implementation by default.
456+
'label callback' => 'entity_class_label',
457+
'uri callback' => 'entity_class_uri',
458+
'bundles' => array(
459+
'restful_test_translatable_entity' => array(
460+
'label' => 'Translatable Test Entity'
461+
)
462+
),
463+
'bundle keys' => array(
464+
'bundle' => 'name',
465+
),
466+
'module' => 'restful_test',
467+
'translation' => array(
468+
'locale' => TRUE,
469+
),
470+
),
471+
);
472+
}

0 commit comments

Comments
 (0)
Please sign in to comment.