-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
[Translator][FileDumper] deprecated format method in favor of formatCatalogue. #15699
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
Conversation
@@ -109,6 +109,8 @@ protected function formatCatalogue(MessageCatalogue $messages, $domain, array $o | |||
* @param string $domain | |||
* | |||
* @return string representation | |||
* | |||
* @deprecated since version 2.8, to be removed in 3.0. Use formatCatalogue() instead. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the message should say Overwrite ....
rather than Use ...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
and you should trigger a deprecation warning in the formatCatalogue
of this class, telling it should be overwritten instead of overwriting format
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
dbf8b68
to
0ddc7b5
Compare
0ddc7b5
to
73573b6
Compare
73573b6
to
366879b
Compare
…avor of formatCatalogue. (aitboudad) This PR was merged into the 2.8 branch. Discussion ---------- [Translator][FileDumper] deprecated format method in favor of formatCatalogue. | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | yes | Fixed tickets | ~ | Tests pass? | yes | License | MIT We introduced `formatCatalogue` to allow using options passed to the dump method. Commits ------- 366879b [Translator][FileDumper] deprecated format method in favor of formatCatalogue.
@@ -109,6 +111,8 @@ protected function formatCatalogue(MessageCatalogue $messages, $domain, array $o | |||
* @param string $domain | |||
* | |||
* @return string representation | |||
* | |||
* @deprecated since version 2.8, to be removed in 3.0. Overwrite formatCatalogue() instead. | |||
*/ | |||
abstract protected function format(MessageCatalogue $messages, $domain); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@aitboudad this method should be implemented now (throwing an exception saying it must be implemented), to allow new child classes to implement only formatCatalogue
and not both methods
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see #15832 and thanks for the hint.
…plement only formatCatalogue (aitboudad) This PR was merged into the 2.8 branch. Discussion ---------- [Translation][File dumper] allow new child classes to implement only formatCatalogue | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Fixed tickets | #15699 | Tests pass? | yes | License | MIT Commits ------- 5fd9f2f [Translation][File dumper] allow new child classes to implement only formatCatalogue.
We introduced
formatCatalogue
to allow using options passed to the dump method.