Cannot serialize IntlTimeZone objects #7939

Activity

1. drjayvee

   added

   Bug

   Status: Needs Triage

   on Jan 13, 2022
2. iluuu1994 commented on Jan 13, 2022

   

   iluuu1994

   on Jan 13, 2022

   Member

   More actions

   It doesn't look like IntlTimeZone supports serialization.

   https://3v4l.org/jnXqP#v8.1.1

   $tz = IntlTimeZone::createTimeZone('Europe/Amsterdam');
   var_dump(serialize($tz));

   string(24) "O:12:"IntlTimeZone":0:{}"
   

   But we could throw an error or at least emit some warning.
3. iluuu1994

   added

   Extension: intl

   Status: Verified

   and removed

   Status: Needs Triage

   on Jan 13, 2022
4. drjayvee commented on Jan 13, 2022

   

   drjayvee

   on Jan 13, 2022

   Author

   More actions

   Would it be difficult to implement serialization? Or do you worry about backwards compatibility?
5. iluuu1994 commented on Jan 13, 2022

   

   iluuu1994

   on Jan 13, 2022

   Member

   More actions

   @drjayvee I know nothing about intl so I'm not sure. Compatibility shouldn't be a concern.
6. cmb69 commented on Jan 15, 2022

   

   cmb69

   on Jan 15, 2022

   Member

   More actions

   Would it be difficult to implement serialization?

   I don't think it would be difficult, but what is the use case? I assume that IntlTimezone is most often used with IntlCalendar and IntlDateFormatter, but neither of these properly supports (un)serialization. Other classes of the intl extension might exhibit the same behavior.
7. cmb69

   linked a pull request that will close this issueFix GH-7939: Cannot unserialize IntlTimeZone objects #7945on Jan 15, 2022
8. drjayvee commented on Jan 17, 2022

   

   drjayvee

   on Jan 17, 2022

   Last edited by drjayvee

   Author

   More actions

   I was under the admittedly naive assumption that every class supports serialization, unless it's especially tricky.

   Our particular use case is:

   class LocaleConfiguration {
     public IntlTimeZone $timeZone = null;
     public string $locale = 'en-US';
     public int $firstWeekDay = 1;
     // etc
   }

   And then cache the user's configuration in their session, memory cache, or elsewhere.

   The simple yet awkward workaround is

   public function __serialize(): array {
     return [
       'timeZone'     => $this->timeZone->getID(),
       'locale'       => $this->locale,
       'firstWeekDay' => $this->firstWeekDay,
       // etc
     ];
   }
   
   // reverse for __unserialize()
9. cmb69 commented on Jan 17, 2022

   

   cmb69

   on Jan 17, 2022

   Member

   More actions

   Okay, for this case being able to (un)serialize IntlTimeZone objects would make sense.

   Note, though, that a lot of internal classes don't support (un)serialization.
10. cmb69

    added a commit that references this issue on Jan 18, 2022

    Fix phpGH-7939: Cannot unserialize IntlTimeZone objects

    ...

    This issue will close once commit c79c174 is merged into the 'master' branch.

    c79c174
11. cmb69

    closed this as completedin f06ac9aon Feb 17, 2022
12. cmb69 commented on Feb 17, 2022

    

    cmb69

    on Feb 17, 2022

    Member

    More actions

    Serialization of these objects will be disallowed as of PHP 8.2.0. PRs to properly support (un)serialization (of individual classes) are welcome!