Skip to content

Commit 51c9377

Browse files
NyholmNyholm
authored
Using MessageInterface (#191)
* Using MessageInterface * Renamed variables * Update dependencies * cs * Bugfix
1 parent c90807c commit 51c9377

File tree

6 files changed

+34
-37
lines changed

6 files changed

+34
-37
lines changed

‎Controller/EditInPlaceController.php‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
use Translation\Bundle\Exception\MessageValidationException;
1818
use Translation\Bundle\Service\StorageService;
1919
use Translation\Common\Model\Message;
20+
use Translation\Common\Model\MessageInterface;
2021

2122
/**
2223
* @author Damien Alexandre <[email protected]>
@@ -57,7 +58,7 @@ public function editAction(Request $request, $configName, $locale)
5758
* @param string $locale
5859
* @param array $validationGroups
5960
*
60-
* @return Message[]
61+
* @return MessageInterface[]
6162
*
6263
* @throws MessageValidationException
6364
*/
@@ -71,11 +72,7 @@ private function getMessages(Request $request, $locale, array $validationGroups
7172
foreach ($data as $key => $value) {
7273
list($domain, $translationKey) = explode('|', $key);
7374

74-
$message = new Message();
75-
$message->setKey($translationKey);
76-
$message->setTranslation($value);
77-
$message->setDomain($domain);
78-
$message->setLocale($locale);
75+
$message = new Message($translationKey, $domain, $locale, $value);
7976

8077
$errors = $validator->validate($message, null, $validationGroups);
8178
if (count($errors) > 0) {

‎Controller/SymfonyProfilerController.php‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
use Symfony\Component\VarDumper\Cloner\Data;
1919
use Translation\Bundle\Model\SfProfilerMessage;
2020
use Translation\Bundle\Service\StorageService;
21-
use Translation\Common\Model\Message;
21+
use Translation\Common\Model\MessageInterface;
2222

2323
/**
2424
* @author Tobias Nyholm <[email protected]>
@@ -154,16 +154,16 @@ private function getMessage(Request $request, $token)
154154
throw $this->createNotFoundException('No collector with name "translation" was found.');
155155
}
156156

157-
$messages = $dataCollector->getMessages();
157+
$collectorMessages = $dataCollector->getMessages();
158158

159-
if ($messages instanceof Data) {
160-
$messages = $messages->getValue(true);
159+
if ($collectorMessages instanceof Data) {
160+
$collectorMessages = $collectorMessages->getValue(true);
161161
}
162162

163-
if (!isset($messages[$messageId])) {
163+
if (!isset($collectorMessages[$messageId])) {
164164
throw $this->createNotFoundException(sprintf('No message with key "%s" was found.', $messageId));
165165
}
166-
$message = SfProfilerMessage::create($messages[$messageId]);
166+
$message = SfProfilerMessage::create($collectorMessages[$messageId]);
167167

168168
if (DataCollectorTranslator::MESSAGE_EQUALS_FALLBACK === $message->getState()) {
169169
$message->setLocale($profile->getCollector('request')->getLocale())
@@ -177,7 +177,7 @@ private function getMessage(Request $request, $token)
177177
* @param Request $request
178178
* @param string $token
179179
*
180-
* @return Message[]
180+
* @return MessageInterface[]
181181
*/
182182
protected function getSelectedMessages(Request $request, $token)
183183
{

‎Controller/WebUIController.php‎

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
use Translation\Common\Exception\StorageException;
2323
use Translation\Bundle\Model\CatalogueMessage;
2424
use Translation\Common\Model\Message;
25+
use Translation\Common\Model\MessageInterface;
2526

2627
/**
2728
* @author Tobias Nyholm <[email protected]>
@@ -141,8 +142,8 @@ public function createAction(Request $request, $configName, $locale, $domain)
141142

142143
try {
143144
$message = $this->getMessageFromRequest($request);
144-
$message->setDomain($domain);
145-
$message->setLocale($locale);
145+
$message = $message->withDomain($domain);
146+
$message = $message->withLocale($locale);
146147
$this->validateMessage($message, ['Create']);
147148
} catch (MessageValidationException $e) {
148149
return new Response($e->getMessage(), 400);
@@ -180,8 +181,8 @@ public function editAction(Request $request, $configName, $locale, $domain)
180181

181182
try {
182183
$message = $this->getMessageFromRequest($request);
183-
$message->setDomain($domain);
184-
$message->setLocale($locale);
184+
$message = $message->withDomain($domain);
185+
$message = $message->withLocale($locale);
185186
$this->validateMessage($message, ['Edit']);
186187
} catch (MessageValidationException $e) {
187188
return new Response($e->getMessage(), 400);
@@ -210,8 +211,8 @@ public function deleteAction(Request $request, $configName, $locale, $domain)
210211

211212
try {
212213
$message = $this->getMessageFromRequest($request);
213-
$message->setLocale($locale);
214-
$message->setDomain($domain);
214+
$message = $message->withLocale($locale);
215+
$message = $message->withDomain($domain);
215216
$this->validateMessage($message, ['Delete']);
216217
} catch (MessageValidationException $e) {
217218
return new Response($e->getMessage(), 400);
@@ -227,18 +228,15 @@ public function deleteAction(Request $request, $configName, $locale, $domain)
227228
/**
228229
* @param Request $request
229230
*
230-
* @return Message
231+
* @return MessageInterface
231232
*/
232233
private function getMessageFromRequest(Request $request)
233234
{
234235
$json = $request->getContent();
235236
$data = json_decode($json, true);
236-
$message = new Message();
237-
if (isset($data['key'])) {
238-
$message->setKey($data['key']);
239-
}
237+
$message = new Message($data['key']);
240238
if (isset($data['message'])) {
241-
$message->setTranslation($data['message']);
239+
$message = $message->withTranslation($data['message']);
242240
}
243241

244242
return $message;
@@ -262,12 +260,12 @@ private function getLocale2LanguageMap()
262260
}
263261

264262
/**
265-
* @param Message $message
266-
* @param array $validationGroups
263+
* @param MessageInterface $message
264+
* @param array $validationGroups
267265
*
268266
* @throws MessageValidationException
269267
*/
270-
private function validateMessage(Message $message, array $validationGroups)
268+
private function validateMessage(MessageInterface $message, array $validationGroups)
271269
{
272270
$errors = $this->get('validator')->validate($message, null, $validationGroups);
273271
if (count($errors) > 0) {

‎Model/SfProfilerMessage.php‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313

1414
use Symfony\Component\VarDumper\Cloner\Data;
1515
use Translation\Common\Model\Message;
16+
use Translation\Common\Model\MessageInterface;
1617

1718
/**
1819
* @author Tobias Nyholm <[email protected]>
@@ -118,9 +119,9 @@ public static function create(array $data)
118119
}
119120

120121
/**
121-
* Convert to a Common\Message.
122+
* Convert to a Common\Model\MessageInterface.
122123
*
123-
* @return Message
124+
* @return MessageInterface
124125
*/
125126
public function convertToMessage()
126127
{

‎Service/StorageService.php‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
use Translation\Bundle\Model\Configuration;
1818
use Translation\Common\Exception\LogicException;
1919
use Translation\Common\Model\Message;
20+
use Translation\Common\Model\MessageInterface;
2021
use Translation\Common\Storage;
2122
use Translation\Common\TransferableStorage;
2223

@@ -208,7 +209,7 @@ private function getFromStorages(array $storages, $locale, $domain, $key)
208209
*
209210
* {@inheritdoc}
210211
*/
211-
public function create(Message $message)
212+
public function create(MessageInterface $message)
212213
{
213214
// Validate if message actually has data
214215
if (empty((array) $message)) {
@@ -229,18 +230,18 @@ public function create(Message $message)
229230
*
230231
* {@inheritdoc}
231232
*/
232-
public function update(Message $message)
233+
public function update(MessageInterface $message)
233234
{
234235
foreach ([$this->localStorages, $this->remoteStorages] as $storages) {
235236
$this->updateStorages($storages, $message);
236237
}
237238
}
238239

239240
/**
240-
* @param Storage[] $storages
241-
* @param Message $message
241+
* @param Storage[] $storages
242+
* @param MessageInterface $message
242243
*/
243-
private function updateStorages(array $storages, Message $message)
244+
private function updateStorages(array $storages, MessageInterface $message)
244245
{
245246
// Validate if message actually has data
246247
if (empty((array) $message)) {

‎composer.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
"symfony/finder": "^2.7 || ^3.0 || ^4.0",
1818
"symfony/intl": "^2.7 || ^3.0 || ^4.0",
1919

20-
"php-translation/common": "^0.2.1",
21-
"php-translation/symfony-storage": "^0.4.0",
20+
"php-translation/common": "^0.3",
21+
"php-translation/symfony-storage": "^0.5.0",
2222
"php-translation/extractor": "^1.3"
2323
},
2424
"require-dev": {

0 commit comments

Comments
 (0)