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.

Sign up for GitHub

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

Jump to bottom

Fix translator and interval serialization #3005

Merged
merged 2 commits into from
Apr 30, 2024
Merged

Fix translator and interval serialization #3005

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
40a728d
Fix translator and interval serialization
kylekatarnls Apr 30, 2024
aa68a82
Test translation after serialization
kylekatarnls Apr 30, 2024
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
4 changes: 4 additions & 0 deletions phpstan.neon
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@ parameters:
message: '#^Instantiated class Doctrine\\DBAL\\Platforms\\MySQL57Platform not found\.#'
paths:
- tests/Doctrine/CarbonTypesTest.php
-
message: '#^Call to an undefined method Symfony\\Contracts\\Translation\\TranslatorInterface::getMessages\(\)\.#'
paths:
- tests/CarbonInterval/ConstructTest.php
excludePaths:
- '*/src/Carbon/CarbonPeriod.php'
- '*/src/Carbon/Laravel/ServiceProvider.php'
Expand Down
29 changes: 23 additions & 6 deletions src/Carbon/AbstractTranslator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,12 +88,7 @@ public static function get(?string $locale = null): static

public function __construct($locale, ?MessageFormatterInterface $formatter = null, $cacheDir = null, $debug = false)
{
parent::setLocale($locale);
$this->initializing = true;
$this->directories = [__DIR__.'/Lang'];
$this->addLoader('array', new ArrayLoader());
parent::__construct($locale, new MessageFormatterMapper($formatter), $cacheDir, $debug);
$this->initializing = false;
$this->initialize($locale, $formatter, $cacheDir, $debug);
}

/**
Expand Down Expand Up @@ -371,6 +366,28 @@ public function __debugInfo()
];
}

public function __serialize(): array
{
return [
'locale' => $this->getLocale(),
];
}

public function __unserialize(array $data): void
{
$this->initialize($data['locale'] ?? 'en');
}

private function initialize($locale, ?MessageFormatterInterface $formatter = null, $cacheDir = null, $debug = false): void
{
parent::setLocale($locale);
$this->initializing = true;
$this->directories = [__DIR__.'/Lang'];
$this->addLoader('array', new ArrayLoader());
parent::__construct($locale, new MessageFormatterMapper($formatter), $cacheDir, $debug);
$this->initializing = false;
}

private static function compareChunkLists($referenceChunks, $chunks)
{
$score = 0;
Expand Down
19 changes: 11 additions & 8 deletions src/Carbon/CarbonInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1614,23 +1614,26 @@ public function diffFiltered(CarbonInterval $ci, Closure $callback, $date = null
* if null passed, now will be used as comparison reference;
* if any other type, it will be converted to date and used as reference.
* @param int|array $syntax if array passed, parameters will be extracted from it, the array may contains:
* - 'syntax' entry (see below)
* - 'short' entry (see below)
* - 'parts' entry (see below)
* - 'options' entry (see below)
* - 'skip' entry, list of units to skip (array of strings or a single string,
* ⦿ 'syntax' entry (see below)
* ⦿ 'short' entry (see below)
* ⦿ 'parts' entry (see below)
* ⦿ 'options' entry (see below)
* ⦿ 'skip' entry, list of units to skip (array of strings or a single string,
* ` it can be the unit name (singular or plural) or its shortcut
* ` (y, m, w, d, h, min, s, ms, µs).
* - 'aUnit' entry, prefer "an hour" over "1 hour" if true
* ⦿ 'aUnit' entry, prefer "an hour" over "1 hour" if true
* ⦿ 'altNumbers' entry, use alternative numbers if available
* ` (from the current language if true is passed, from the given language(s)
* ` if array or string is passed)
* - 'join' entry determines how to join multiple parts of the string
* ` - if $join is a string, it's used as a joiner glue
* ` - if $join is a callable/closure, it get the list of string and should return a string
* ` - if $join is an array, the first item will be the default glue, and the second item
* ` will be used instead of the glue for the last item
* ` - if $join is true, it will be guessed from the locale ('list' translation file entry)
* ` - if $join is missing, a space will be used as glue
* - 'other' entry (see above)
* - 'minimumUnit' entry determines the smallest unit of time to display can be long or
* ⦿ 'other' entry (see above)
* ⦿ 'minimumUnit' entry determines the smallest unit of time to display can be long or
* ` short form of the units, e.g. 'hour' or 'h' (default value: s)
* if int passed, it add modifiers:
* Possible values:
Expand Down
25 changes: 14 additions & 11 deletions src/Carbon/CarbonInterval.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1819,26 +1819,29 @@ public function getValuesSequence(): array
* echo CarbonInterval::fromString('1d 24h')->forHumans(['minimumUnit' => 'hour']) . "\n";
* ```
*
* @param int|array $syntax if array passed, parameters will be extracted from it, the array may contains:
* - 'syntax' entry (see below)
* - 'short' entry (see below)
* - 'parts' entry (see below)
* - 'options' entry (see below)
* - 'skip' entry, list of units to skip (array of strings or a single string,
* @param int|array $syntax if array passed, parameters will be extracted from it, the array may contain:
* ⦿ 'syntax' entry (see below)
* ⦿ 'short' entry (see below)
* ⦿ 'parts' entry (see below)
* ⦿ 'options' entry (see below)
* ⦿ 'skip' entry, list of units to skip (array of strings or a single string,
* ` it can be the unit name (singular or plural) or its shortcut
* ` (y, m, w, d, h, min, s, ms, µs).
* - 'aUnit' entry, prefer "an hour" over "1 hour" if true
* - 'join' entry determines how to join multiple parts of the string
* ⦿ 'aUnit' entry, prefer "an hour" over "1 hour" if true
* ⦿ 'altNumbers' entry, use alternative numbers if available
* ` (from the current language if true is passed, from the given language(s)
* ` if array or string is passed)
* ⦿ 'join' entry determines how to join multiple parts of the string
* ` - if $join is a string, it's used as a joiner glue
* ` - if $join is a callable/closure, it get the list of string and should return a string
* ` - if $join is an array, the first item will be the default glue, and the second item
* ` will be used instead of the glue for the last item
* ` - if $join is true, it will be guessed from the locale ('list' translation file entry)
* ` - if $join is missing, a space will be used as glue
* - 'minimumUnit' entry determines the smallest unit of time to display can be long or
* ⦿ 'minimumUnit' entry determines the smallest unit of time to display can be long or
* ` short form of the units, e.g. 'hour' or 'h' (default value: s)
* - 'locale' language in which the diff should be output (has no effect if 'translator' key is set)
* - 'translator' a custom translator to use to translator the output.
* ⦿ 'locale' language in which the diff should be output (has no effect if 'translator' key is set)
* ⦿ 'translator' a custom translator to use to translator the output.
* if int passed, it adds modifiers:
* Possible values:
* - CarbonInterface::DIFF_ABSOLUTE no modifiers
Expand Down
25 changes: 14 additions & 11 deletions src/Carbon/Traits/Difference.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -481,26 +481,29 @@ public function secondsUntilEndOfDay(): float
* if null passed, now will be used as comparison reference;
* if any other type, it will be converted to date and used as reference.
* @param int|array $syntax if array passed, parameters will be extracted from it, the array may contains:
* - 'syntax' entry (see below)
* - 'short' entry (see below)
* - 'parts' entry (see below)
* - 'options' entry (see below)
* - 'skip' entry, list of units to skip (array of strings or a single string,
* ⦿ 'syntax' entry (see below)
* ⦿ 'short' entry (see below)
* ⦿ 'parts' entry (see below)
* ⦿ 'options' entry (see below)
* ⦿ 'skip' entry, list of units to skip (array of strings or a single string,
* ` it can be the unit name (singular or plural) or its shortcut
* ` (y, m, w, d, h, min, s, ms, µs).
* - 'aUnit' entry, prefer "an hour" over "1 hour" if true
* - 'join' entry determines how to join multiple parts of the string
* ⦿ 'aUnit' entry, prefer "an hour" over "1 hour" if true
* ⦿ 'altNumbers' entry, use alternative numbers if available
* ` (from the current language if true is passed, from the given language(s)
* ` if array or string is passed)
* ⦿ 'join' entry determines how to join multiple parts of the string
* ` - if $join is a string, it's used as a joiner glue
* ` - if $join is a callable/closure, it get the list of string and should return a string
* ` - if $join is an array, the first item will be the default glue, and the second item
* ` will be used instead of the glue for the last item
* ` - if $join is true, it will be guessed from the locale ('list' translation file entry)
* ` - if $join is missing, a space will be used as glue
* - 'other' entry (see above)
* - 'minimumUnit' entry determines the smallest unit of time to display can be long or
* ⦿ 'other' entry (see above)
* ⦿ 'minimumUnit' entry determines the smallest unit of time to display can be long or
* ` short form of the units, e.g. 'hour' or 'h' (default value: s)
* - 'locale' language in which the diff should be output (has no effect if 'translator' key is set)
* - 'translator' a custom translator to use to translator the output.
* ⦿ 'locale' language in which the diff should be output (has no effect if 'translator' key is set)
* ⦿ 'translator' a custom translator to use to translator the output.
* if int passed, it adds modifiers:
* Possible values:
* - CarbonInterface::DIFF_ABSOLUTE no modifiers
Expand Down
37 changes: 37 additions & 0 deletions tests/CarbonInterval/ConstructTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -429,4 +429,41 @@ public function testEnums()
$this->assertCarbonInterval(CarbonInterval::make(3, Unit::Hour), 0, 0, 0, 3, 0, 0);
$this->assertCarbonInterval(CarbonInterval::make(Unit::Week), 0, 0, 7, 0, 0, 0);
}

public function testFromSerialization()
{
$past = new Carbon('-3 Days');
$today = new Carbon('today');
$interval = $today->diffAsCarbonInterval($past);
/** @var CarbonInterval $copy */
$copy = unserialize(serialize($interval));

$this->assertInstanceOf(CarbonInterval::class, $copy);

$this->assertSame('2 days', $interval->forHumans(parts: 1));
$this->assertSame('2 days', $copy->forHumans(parts: 1));

$this->assertSame(['en'], array_keys($interval->getLocalTranslator()->getMessages()) ?: ['en']);
$this->assertSame(['en'], array_keys($copy->getLocalTranslator()->getMessages()) ?: ['en']);
$this->assertSame($interval->locale, $copy->locale);

// Ignore translator for the English comparison
$copy->setLocalTranslator($interval->getLocalTranslator());

$this->assertEquals($interval, $copy);

$interval = $today->locale('ja')->diffAsCarbonInterval($past);
/** @var CarbonInterval $copy */
$copy = unserialize(serialize($interval));

$this->assertInstanceOf(CarbonInterval::class, $copy);

$this->assertSame('二日', $interval->forHumans(['altNumbers' => true, 'parts' => 1]));
$this->assertSame('二日', $copy->forHumans(['altNumbers' => true, 'parts' => 1]));

$this->assertSame(['ja'], array_keys($interval->getLocalTranslator()->getMessages()));
$this->assertSame(['ja'], array_keys($copy->getLocalTranslator()->getMessages()));

$this->assertEquals($interval, $copy);
}
}
21 changes: 21 additions & 0 deletions tests/Language/TranslatorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,4 +87,25 @@ public function testTranslatorImmutable()
);
TranslatorImmutable::get('en')->setTranslations([]);
}

public function testSerializationKeepLocale()
{
$translator = TranslatorImmutable::get('de');

$this->assertEquals('de', unserialize(serialize($translator))->getLocale());

$past = new Carbon('-3 Days');
$today = new Carbon('today');
$interval = $today->diffAsCarbonInterval($past);
$translator = $interval->getLocalTranslator();

$this->assertEquals('en', unserialize(serialize($translator))->getLocale());

$past = new Carbon('-3 Days');
$today = new Carbon('today');
$interval = $today->locale('zh')->diffAsCarbonInterval($past);
$translator = $interval->getLocalTranslator();

$this->assertEquals('zh', unserialize(serialize($translator))->getLocale());
}
}
Loading