Added documentation for the Intl component #2312

webmozart · 2013-03-15T17:33:29Z

Q	A
Doc fix?	no
New docs?	yes (symfony/symfony#7386)
Applies to	2.3
Fixed tickets	-

stof · 2013-03-15T17:38:45Z

components/intl.rst

+NumberFormatter
+~~~~~~~~~~~~~~~
+
+Numbers can be formatted with the :phpclass:``NumberFormatter`` class.


it should be single backticks AFAIK

Thanks, fixed

webmozart · 2013-03-17T12:35:47Z

Does anyone know how to create alternate TOC titles for section headings? For example, I would like the heading

__construct($locale = $style = null, $pattern = null)

to appear as

__construct()

or

NumberFormatter::__construct()

in the TOC.

webmozart · 2013-03-17T12:37:13Z

Or maybe it's indeed better to move information about which methods are supported to the API docs and only link there here?

wouterj · 2013-03-17T13:04:04Z

components/intl.rst

+* :phpfunction:`intl_get_error_code`
+* :phpfunction:`intl_get_error_message`
+
+If you don't use Composer but the Symfony ClassLoader component, you need to


It is maybe nice to add a link to the ClassLoader component here

stof · 2013-03-19T21:39:41Z

@bschussek IMO, documenting all methods of the API should be left to the API doc (where you could document with more details what is supported by the stub implementation). The component doc should be about the way to use the component, not about all available methods

webmozart · 2013-04-11T09:34:00Z

I integrated the suggested changes now. I hope this PR is now complete.

This PR was merged into the master branch. Discussion ---------- [Intl] Refactored Locale component into two new components Icu and Intl | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | BC breaks? | yes | Deprecations? | yes | Tests pass? | yes | Fixed tickets | #5279 | License | MIT | Doc PR | symfony/symfony-docs#2312 The Intl component is now a simple drop-in replacement layer for the C intl extension. Install it via Composer and have it available automatically if the intl extension is not available. Additionally, the component ships data from the ICU library which can be accessed through the methods: ```php use Symfony\Component\Intl\Intl; Intl::getCurrencyBundle()->... Intl::getLanguageBundle()->... Intl::getLocaleBundle()->... Intl::getRegionBundle()->... ``` If the intl extension is installed, Composer will install the ICU data for the ICU version in the intl extension. If the intl extension is not installed, Composer will use stub ICU data for the latest ICU version (see `Intl::getStubIcuVersion()`). See the [README](/bschussek/symfony/blob/intl/src/Symfony/Component/Intl/README.md) for more information. Todo: - [x] finish the Intl README file - [x] update the Icu README file - [x] update the documentation - [x] make parameter `$locale` optional (default to `\Locale::getDefault()`) in resource bundle methods - [x] remove `(Icu)?Version::compare` calls in the tests - [x] solve deployment problem when trying to install incompatible symfony/icu version listed in composer.lock Create the following branches in the [Icu component](https://github.com/symfony/Icu): - [x] 1.0.x - [x] 1.1.x - [x] 1.2.x Commits ------- 9118b4a [Locale] Removed "Stub" prefixes in Intl component b4cccfd [Intl] Removed "Stub" prefix from stub classes 60f31d1 [Intl] Improved inline documentation c2d37e6 [Intl] Improved error messages in the build scripts 1249f01 [Intl] Added scripts to test the compatibility of various versions of symfony/icu with the ICU version installed on the system 9dbafd7 [Intl] Split update-stubs.php script into two scripts to function with the changed Icu component versioning e2c11cb [Intl] Added a check for the ICU data version to IntlTestHelper to prevent the stub class tests from failing 427d24a [Intl] Outsourced bundle reader creation to Icu component 0160fd5 [Intl] Moved stub data to Icu component 1.0.x dbca3b7 [Intl] Added empty directory needed for the tests a717ce9 [Intl] Removed ICU version comparisons from the tests 5d17de5 [Intl] Fixed version comparisons in the transformation rules 470927d [Intl] Improved build scripts aceb20d [Form] Improved tests to use the IntlTestHelper class 3dd75ff [Locale] Improved tests to use the IntlTestHelper class 03b78b0 [Validator] Improved tests to use the IntlTestHelper class 9d9c389 [Intl] Simplified tests c55c4a2 [Intl] Only the StubNumberFormatterTest requires stub data 17a480b [Intl] Added IntlTestHelper class for convenience 1dcdcd3 [Locale] Fixed failing tests f6b75b9 [Intl] Changed composer.json to disallow future versions of the Icu component 080c880 [Intl] Bumped the stub version to 50.1.2 dd2d013 [Intl] Improved the bundle compilation process f47e60a [Intl] Fixed small bugs in the resource bundle transformation 467cc93 [Intl] Fixed various problems in the resource compilation process 4a5c453 [Intl] Moved the content of the README file to symfony/symfony-docs 9899de7 [Intl] Updated the README bfec58a [Intl] Fixed flawed PHPDoc 21323ba [Intl] Updated the README file 209a9cb [Validator] Adapted to latest Intl changes f2a0aec [Form] Adapted to latest Intl changes 0f6277f [Locale] Adapted to latest Intl changes 2cd1be8 [Intl] Made the $locale parameter optional in the bundle interfaces b9e9cb2 [Intl] Added autoload.php which was ignored by .gitignore 838798f [Intl] Removed method IntlTestCase::skipIfInsufficientIcuVersion() dde1d34 [Intl] Changed Intl::getIcuVersion() to return the stub version if the intl extension is not loaded 99f6f8a [Form] Fixed failing tests 5d0b849 Fixed PHPDoc b60866c [Intl] Changed Intl::getStubIcuVersion() to Intl::getIcuStubVersion() b902b6b [Locale] Added default locale 01d0ee8 [Validator] Changed component to use the Intl component 0c1fe39 [Form] Changed component to use the Intl component 5917a2e [Intl] Refactored Locale component into two new components Icu and Intl

This PR was merged into the master branch. Discussion ---------- [Intl] Refactored Locale component into two new components Icu and Intl | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | BC breaks? | yes | Deprecations? | yes | Tests pass? | yes | Fixed tickets | #5279 | License | MIT | Doc PR | symfony/symfony-docs#2312 The Intl component is now a simple drop-in replacement layer for the C intl extension. Install it via Composer and have it available automatically if the intl extension is not available. Additionally, the component ships data from the ICU library which can be accessed through the methods: ```php use Symfony\Component\Intl\Intl; Intl::getCurrencyBundle()->... Intl::getLanguageBundle()->... Intl::getLocaleBundle()->... Intl::getRegionBundle()->... ``` If the intl extension is installed, Composer will install the ICU data for the ICU version in the intl extension. If the intl extension is not installed, Composer will use stub ICU data for the latest ICU version (see `Intl::getStubIcuVersion()`). See the [README](/bschussek/symfony/blob/intl/src/Symfony/Component/Intl/README.md) for more information. Todo: - [x] finish the Intl README file - [x] update the Icu README file - [x] update the documentation - [x] make parameter `$locale` optional (default to `\Locale::getDefault()`) in resource bundle methods - [x] remove `(Icu)?Version::compare` calls in the tests - [x] solve deployment problem when trying to install incompatible symfony/icu version listed in composer.lock Create the following branches in the [Icu component](https://github.com/symfony/Icu): - [x] 1.0.x - [x] 1.1.x - [x] 1.2.x Commits ------- 9118b4a [Locale] Removed "Stub" prefixes in Intl component b4cccfd [Intl] Removed "Stub" prefix from stub classes 60f31d1 [Intl] Improved inline documentation c2d37e6 [Intl] Improved error messages in the build scripts 1249f01 [Intl] Added scripts to test the compatibility of various versions of symfony/icu with the ICU version installed on the system 9dbafd7 [Intl] Split update-stubs.php script into two scripts to function with the changed Icu component versioning e2c11cb [Intl] Added a check for the ICU data version to IntlTestHelper to prevent the stub class tests from failing 427d24a [Intl] Outsourced bundle reader creation to Icu component 0160fd5 [Intl] Moved stub data to Icu component 1.0.x dbca3b7 [Intl] Added empty directory needed for the tests a717ce9 [Intl] Removed ICU version comparisons from the tests 5d17de5 [Intl] Fixed version comparisons in the transformation rules 470927d [Intl] Improved build scripts aceb20d [Form] Improved tests to use the IntlTestHelper class 3dd75ff [Locale] Improved tests to use the IntlTestHelper class 03b78b0 [Validator] Improved tests to use the IntlTestHelper class 9d9c389 [Intl] Simplified tests c55c4a2 [Intl] Only the StubNumberFormatterTest requires stub data 17a480b [Intl] Added IntlTestHelper class for convenience 1dcdcd3 [Locale] Fixed failing tests f6b75b9 [Intl] Changed composer.json to disallow future versions of the Icu component 080c880 [Intl] Bumped the stub version to 50.1.2 dd2d013 [Intl] Improved the bundle compilation process f47e60a [Intl] Fixed small bugs in the resource bundle transformation 467cc93 [Intl] Fixed various problems in the resource compilation process 4a5c453 [Intl] Moved the content of the README file to symfony/symfony-docs 9899de7 [Intl] Updated the README bfec58a [Intl] Fixed flawed PHPDoc 21323ba [Intl] Updated the README file 209a9cb [Validator] Adapted to latest Intl changes f2a0aec [Form] Adapted to latest Intl changes 0f6277f [Locale] Adapted to latest Intl changes 2cd1be8 [Intl] Made the $locale parameter optional in the bundle interfaces b9e9cb2 [Intl] Added autoload.php which was ignored by .gitignore 838798f [Intl] Removed method IntlTestCase::skipIfInsufficientIcuVersion() dde1d34 [Intl] Changed Intl::getIcuVersion() to return the stub version if the intl extension is not loaded 99f6f8a [Form] Fixed failing tests 5d0b849 Fixed PHPDoc b60866c [Intl] Changed Intl::getStubIcuVersion() to Intl::getIcuStubVersion() b902b6b [Locale] Added default locale 01d0ee8 [Validator] Changed component to use the Intl component 0c1fe39 [Form] Changed component to use the Intl component 5917a2e [Intl] Refactored Locale component into two new components Icu and Intl

webmozart · 2013-04-20T16:46:02Z

This can be merged.

weaverryan · 2013-04-26T13:48:50Z

Hi Bernhard!

Before I merge this in, I have a few high-level questions.

Are there any implications / BC breaks going from the Locale component to the intl component? I didn't notice anything in the UPGRADE docs, but it seems like there would be something that we'd want to highlight for users (e.g. "Before Symfony 2.3, Locale::getDisplayLanguages('fr'); was used. Now, use $countries = Intl::getRegionBundle()->getCountryNames();" <- that may not be a real example, but you get the picture).
How about giving people information about the ICU stuff? Or is this something that we generally think will be entirely invisible to the user? Are there cases when you'll need to manually switch your ICU branch?

Thanks!

wouterj · 2013-04-28T09:35:27Z

1 is fixed in symfony/symfony#7867

webmozart · 2013-04-28T10:23:12Z

Thank you for the feedback @weaverryan!

As @wouterj mentioned, I fixed (1) in the symfony/symfony repository. (2) is fixed in the commit I just added to this PR. I hope this is better now! :)

wouterj · 2013-04-28T11:11:30Z

components/intl.rst

+
+    The replacement layer is limited to the locale "en". If you want to use
+    other locales, you should `install the intl extension`_ instead.
+


You are missing a .. versionadded:: 2.3 directive

weaverryan · 2013-04-30T13:23:45Z

@bschussek very very nice tweaks - you make things easy!

Merged with only minor changes at sha: 019bed7 (but let me know if you see something you don't like).

Thanks!

webmozart · 2013-04-30T13:37:25Z

Thank you for the tweaks @weaverryan! :) Being corrected by a native speaker is a great learning opportunity.

This PR was merged into the master branch. Discussion ---------- [Intl] Refactored Locale component into two new components Icu and Intl | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | BC breaks? | yes | Deprecations? | yes | Tests pass? | yes | Fixed tickets | #5279 | License | MIT | Doc PR | symfony/symfony-docs#2312 The Intl component is now a simple drop-in replacement layer for the C intl extension. Install it via Composer and have it available automatically if the intl extension is not available. Additionally, the component ships data from the ICU library which can be accessed through the methods: ```php use Symfony\Component\Intl\Intl; Intl::getCurrencyBundle()->... Intl::getLanguageBundle()->... Intl::getLocaleBundle()->... Intl::getRegionBundle()->... ``` If the intl extension is installed, Composer will install the ICU data for the ICU version in the intl extension. If the intl extension is not installed, Composer will use stub ICU data for the latest ICU version (see `Intl::getStubIcuVersion()`). See the [README](/bschussek/symfony/blob/intl/src/Symfony/Component/Intl/README.md) for more information. Todo: - [x] finish the Intl README file - [x] update the Icu README file - [x] update the documentation - [x] make parameter `$locale` optional (default to `\Locale::getDefault()`) in resource bundle methods - [x] remove `(Icu)?Version::compare` calls in the tests - [x] solve deployment problem when trying to install incompatible symfony/icu version listed in composer.lock Create the following branches in the [Icu component](https://github.com/symfony/Icu): - [x] 1.0.x - [x] 1.1.x - [x] 1.2.x Commits ------- 9118b4a [Locale] Removed "Stub" prefixes in Intl component b4cccfd [Intl] Removed "Stub" prefix from stub classes 60f31d1 [Intl] Improved inline documentation c2d37e6 [Intl] Improved error messages in the build scripts 1249f01 [Intl] Added scripts to test the compatibility of various versions of symfony/icu with the ICU version installed on the system 9dbafd7 [Intl] Split update-stubs.php script into two scripts to function with the changed Icu component versioning e2c11cb [Intl] Added a check for the ICU data version to IntlTestHelper to prevent the stub class tests from failing 427d24a [Intl] Outsourced bundle reader creation to Icu component 0160fd5 [Intl] Moved stub data to Icu component 1.0.x dbca3b7 [Intl] Added empty directory needed for the tests a717ce9 [Intl] Removed ICU version comparisons from the tests 5d17de5 [Intl] Fixed version comparisons in the transformation rules 470927d [Intl] Improved build scripts aceb20d [Form] Improved tests to use the IntlTestHelper class 3dd75ff [Locale] Improved tests to use the IntlTestHelper class 03b78b0 [Validator] Improved tests to use the IntlTestHelper class 9d9c389 [Intl] Simplified tests c55c4a2 [Intl] Only the StubNumberFormatterTest requires stub data 17a480b [Intl] Added IntlTestHelper class for convenience 1dcdcd3 [Locale] Fixed failing tests f6b75b9 [Intl] Changed composer.json to disallow future versions of the Icu component 080c880 [Intl] Bumped the stub version to 50.1.2 dd2d013 [Intl] Improved the bundle compilation process f47e60a [Intl] Fixed small bugs in the resource bundle transformation 467cc93 [Intl] Fixed various problems in the resource compilation process 4a5c453 [Intl] Moved the content of the README file to symfony/symfony-docs 9899de7 [Intl] Updated the README bfec58a [Intl] Fixed flawed PHPDoc 21323ba [Intl] Updated the README file 209a9cb [Validator] Adapted to latest Intl changes f2a0aec [Form] Adapted to latest Intl changes 0f6277f [Locale] Adapted to latest Intl changes 2cd1be8 [Intl] Made the $locale parameter optional in the bundle interfaces b9e9cb2 [Intl] Added autoload.php which was ignored by .gitignore 838798f [Intl] Removed method IntlTestCase::skipIfInsufficientIcuVersion() dde1d34 [Intl] Changed Intl::getIcuVersion() to return the stub version if the intl extension is not loaded 99f6f8a [Form] Fixed failing tests 5d0b849 Fixed PHPDoc b60866c [Intl] Changed Intl::getStubIcuVersion() to Intl::getIcuStubVersion() b902b6b [Locale] Added default locale 01d0ee8 [Validator] Changed component to use the Intl component 0c1fe39 [Form] Changed component to use the Intl component 5917a2e [Intl] Refactored Locale component into two new components Icu and Intl

webmozart mentioned this pull request Mar 15, 2013

[Intl] Refactored Locale component into two new components Icu and Intl symfony/symfony#7386

Merged

9 tasks

stof reviewed Mar 15, 2013
View reviewed changes

wouterj reviewed Mar 17, 2013
View reviewed changes

webmozart added 3 commits April 5, 2013 11:01

Added documentation for the Intl component

4c9b689

Fixed quirks in the Intl documentation

cfea950

Improved Intl documentation based on the PR comments

64da9d7

wouterj reviewed Apr 28, 2013
View reviewed changes

Added a sidebar about potential deployment problems with ICU

cce4b51

weaverryan added a commit that referenced this pull request Apr 30, 2013

[#2312] Minor tweaks for new intl component documentation

019bed7

weaverryan merged commit cce4b51 into symfony:master Apr 30, 2013

weaverryan added a commit that referenced this pull request May 28, 2013

[#2312] Fixing typo thanks to @staabm

23a016c

webmozart deleted the intl branch February 27, 2014 13:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added documentation for the Intl component #2312

Added documentation for the Intl component #2312

webmozart commented Mar 15, 2013

stof Mar 15, 2013

webmozart Mar 17, 2013

webmozart commented Mar 17, 2013

webmozart commented Mar 17, 2013

wouterj Mar 17, 2013

stof commented Mar 19, 2013

webmozart commented Apr 11, 2013

webmozart commented Apr 20, 2013

weaverryan commented Apr 26, 2013

wouterj commented Apr 28, 2013

webmozart commented Apr 28, 2013

wouterj Apr 28, 2013

webmozart Apr 28, 2013

weaverryan commented Apr 30, 2013

webmozart commented Apr 30, 2013


		The replacement layer is limited to the locale "en". If you want to use
		other locales, you should `install the intl extension`_ instead.

Added documentation for the Intl component #2312

Added documentation for the Intl component #2312

Conversation

webmozart commented Mar 15, 2013

stof Mar 15, 2013

Choose a reason for hiding this comment

webmozart Mar 17, 2013

Choose a reason for hiding this comment

webmozart commented Mar 17, 2013

webmozart commented Mar 17, 2013

wouterj Mar 17, 2013

Choose a reason for hiding this comment

stof commented Mar 19, 2013

webmozart commented Apr 11, 2013

webmozart commented Apr 20, 2013

weaverryan commented Apr 26, 2013

wouterj commented Apr 28, 2013

webmozart commented Apr 28, 2013

wouterj Apr 28, 2013

Choose a reason for hiding this comment

webmozart Apr 28, 2013

Choose a reason for hiding this comment

weaverryan commented Apr 30, 2013

webmozart commented Apr 30, 2013