From: Nikita Popov Date: Fri, 26 Jan 2018 21:13:11 +0000 (+0100) Subject: Drop the ext/intl/doc directory X-Git-Tag: php-7.3.0alpha1~538 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=e061a4e9e4647e73d799c8d8b4c02e1441411c18;p=php Drop the ext/intl/doc directory Drop outdated documentation stubs. Better intl documentation is available in the manual... --- diff --git a/ext/intl/doc/Tutorial.txt b/ext/intl/doc/Tutorial.txt deleted file mode 100644 index 3bb31b00ec..0000000000 --- a/ext/intl/doc/Tutorial.txt +++ /dev/null @@ -1,239 +0,0 @@ -1. Collator::getAvailableLocales(). -Return the locales available at the time of the call, including registered locales. -If a sever error occurs (such as out of memory condition) this will return null. -If there is no locale data, an empty enumeration will be returned. -Returned locales list is a strings in format of RFC4646 standart (see http://www.rfc-editor.org/rfc/rfc4646.txt). -Examle of locales format: 'en_US', 'ru_UA', 'ua_UA' (see http://demo.icu-project.org/icu-bin/locexp). - - -2. Collator::getDisplayName( $obj_locale, $disp_locale ). -Get name of the object for the desired Locale, in the desired language. Both arguments -must be from getAvailableLocales method. - - @param string $obj_locale Locale to get display name for. - @param string $disp_locale Specifies the desired locale for output - -Both parameters are case insensitive. -For locale format see RFC4647 standart in ftp://ftp.rfc-editor.org/in-notes/rfc4647.txt - -3. Collator::getLocaleByType( $type ). -Allow user to select whether she wants information on requested, valid or actual locale. -Returned locale tag is a string formatted to a RFC4646 standart and normalize to normal form - -value is a string from -For example, a collator for "en_US_CALIFORNIA" was requested. In the current state of ICU (2.0), -the requested locale is "en_US_CALIFORNIA", the valid locale is "en_US" (most specific locale -supported by ICU) and the actual locale is "root" (the collation data comes unmodified from the UCA) -The locale is considered supported by ICU if there is a core ICU bundle for that locale (although -it may be empty). - - -4. VariableTop -The Variable_Top attribute is only meaningful if the Alternate attribute is not set to NonIgnorable. -In such a case, it controls which characters count as ignorable. The string value specifies -the "highest" character (in UCA order) weight that is to be considered ignorable. -Thus, for example, if a user wanted whitespace to be ignorable, but not any visible characters, -then s/he would use the value Variable_Top="\u0020" (space). The string should only be a -single character. All characters of the same primary weight are equivalent, so -Variable_Top="\u3000" (ideographic space) has the same effect as Variable_Top="\u0020". -This setting (alone) has little impact on string comparison performance; setting it lower or higher -will make sort keys slightly shorter or longer respectively. - - -5. Strength -The ICU Collation Service supports many levels of comparison (named "Levels", but also -known as "Strengths"). Having these categories enables ICU to sort strings precisely -according to local conventions. However, by allowing the levels to be selectively -employed, searching for a string in text can be performed with various matching -conditions. -Performance optimizations have been made for ICU collation with the default level -settings. Performance specific impacts are discussed in the Performance section below. -Following is a list of the names for each level and an example usage: - -1. Primary Level: Typically, this is used to denote differences between base characters -(for example, "a" < "b"). It is the strongest difference. For example, dictionaries are -divided into different sections by base character. This is also called the level1 -strength. - -2. Secondary Level: Accents in the characters are considered secondary differences (for -example, "as" < "as" < "at"). Other differences between letters can also be considered -secondary differences, depending on the language. A secondary difference is ignored -when there is a primary difference anywhere in the strings. This is also called the -level2 strength. -Note: In some languages (such as Danish), certain accented letters are considered to -be separate base characters. In most languages, however, an accented letter only has a -secondary difference from the unaccented version of that letter. - -3. Tertiary Level: Upper and lower case differences in characters are distinguished at the -tertiary level (for example, "ao" < "Ao" < "ao"). In addition, a variant of a letter differs -from the base form on the tertiary level (such as "A" and " "). Another ? example is the -difference between large and small Kana. A tertiary difference is ignored when there is -a primary or secondary difference anywhere in the strings. This is also called the level3 -strength. - -4. Quaternary Level: When punctuation is ignored (see Ignoring Punctuations ) at level -13, an additional level can be used to distinguish words with and without punctuation -(for example, "ab" < "a-b" < "aB"). This difference is ignored when there is a primary, -secondary or tertiary difference. This is also known as the level4 strength. The -quaternary level should only be used if ignoring punctuation is required or when -processing Japanese text (see Hiragana processing). - -5. Identical Level: When all other levels are equal, the identical level is used as a -tiebreaker. The Unicode code point values of the NFD form of each string are -compared at this level, just in case there is no difference at levels 14 -. For example, Hebrew cantillation marks are only distinguished at this level. This level should be -used sparingly, as only code point values differences between two strings is an -extremely rare occurrence. Using this level substantially decreases the performance for -both incremental comparison and sort key generation (as well as increasing the sort -key length). It is also known as level 5 strength. - -For example, people may choose to ignore accents or ignore accents and case when searching -for text. Almost all characters are distinguished by the first three levels, and in most -locales the default value is thus Tertiary. However, if Alternate is set to be Shifted, -then the Quaternary strength can be used to break ties among whitespace, punctuation, and -symbols that would otherwise be ignored. If very fine distinctions among characters are required, -then the Identical strength can be used (for example, Identical Strength distinguishes -between the Mathematical Bold Small A and the Mathematical Italic Small A.). However, using -levels higher than Tertiary the Identical strength result in significantly longer sort -keys, and slower string comparison performance for equal strings. - - - -6. Collator::__construct( $locale ). -The Locale attribute is typically the most important attribute for correct sorting and matching, -according to the user expectations in different countries and regions. The default UCA -ordering will only sort a few languages such as Dutch and Portuguese correctly ("correctly" -meaning according to the normal expectations for users of the languages). -Otherwise, you need to supply the locale to UCA in order to properly collate text for a -given language. Thus a locale needs to be supplied so as to choose a collator that is correctly -tailored for that locale. The choice of a locale will automatically preset the values for -all of the attributes to something that is reasonable for that locale. Thus most of the time the -other attributes do not need to be explicitly set. In some cases, the choice of locale will make a -difference in string comparison performance and/or sort key length. -In short attribute names, _