Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: lang() may return false #7966

Merged
merged 3 commits into from
Oct 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion system/Language/Language.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
namespace CodeIgniter\Language;

use Config\Services;
use InvalidArgumentException;
use MessageFormatter;

/**
Expand Down Expand Up @@ -191,7 +192,14 @@ protected function formatMessage($message, array $args = [])
return $message;
}

return MessageFormatter::formatMessage($this->locale, $message, $args);
$formatted = MessageFormatter::formatMessage($this->locale, $message, $args);
if ($formatted === false) {
throw new InvalidArgumentException(
lang('Language.invalidMessageFormat', [$message, implode(',', $args)])
);
}

return $formatted;
}

/**
Expand Down
15 changes: 15 additions & 0 deletions system/Language/en/Language.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?php

/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/

// "Language" language settings
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// "Language" language settings

I don't think it is necessary.

return [
'invalidMessageFormat' => 'Invalid message format: "{0}", args: "{1}"',
];
25 changes: 25 additions & 0 deletions tests/system/Language/LanguageTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
use CodeIgniter\Test\CIUnitTestCase;
use CodeIgniter\Test\Mock\MockLanguage;
use Config\Services;
use InvalidArgumentException;
use MessageFormatter;
use Tests\Support\Language\SecondMockLanguage;

Expand Down Expand Up @@ -126,6 +127,30 @@ public function testGetLineArrayFormatsMessages(): void
$this->assertSame(['45 related books.'], $this->lang->getLine('books.bookList', [91 / 2]));
}

/**
* @see https://github.com/codeigniter4/shield/issues/851
*/
public function testGetLineInvalidFormatMessage(): void
{
// No intl extension? then we can't test this - go away....
if (! class_exists(MessageFormatter::class)) {
$this->markTestSkipped('No intl support.');
}

$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage(
'Invalid message format: "تم الكشف عن كلمة المرور {0} بسبب اختراق البيانات وشوهدت {1 ، عدد} مرة في {2} في كلمات المرور المخترقة.", args: "password,hits,wording"'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this normal (language) for tests?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes it might be better to make a comment as to explain testing of Arabic as international languages.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Set locale to ar.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requesting comment for test language

);

$this->lang->setLocale('ar');

$this->lang->setData('Auth', [
'errorPasswordPwned' => 'تم الكشف عن كلمة المرور {0} بسبب اختراق البيانات وشوهدت {1 ، عدد} مرة في {2} في كلمات المرور المخترقة.',
]);

$this->lang->getLine('Auth.errorPasswordPwned', ['password', 'hits', 'wording']);
}

/**
* @see https://github.com/codeigniter4/CodeIgniter4/issues/891
*/
Expand Down
2 changes: 2 additions & 0 deletions user_guide_src/source/changelogs/v4.4.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ BREAKING
Message Changes
***************

- Added ``Language.invalidMessageFormat`` error message.

Changes
*******

Expand Down
Loading