repo_zf1Php7/documentation/manual/en/module_specs/Zend_Locale-Parsing.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<sect1 id="zend.locale.parsing">

    <title>Normalization and Localization</title>

    <para>
        <classname>Zend_Locale_Format</classname> is a internal component used by <classname>Zend_Locale</classname>. All locale aware classes use
        <classname>Zend_Locale_Format</classname> for normalization and localization of numbers and dates. Normalization involves
        parsing input from a variety of data representations, like dates, into a standardized, structured
        representation, such as a PHP array with year, month, and day elements.
    </para>

    <para>
        The exact same string containing a number or a date might mean different things to people with different customs
        and conventions. Disambiguation of numbers and dates requires rules about how to interpret these strings and
        normalize the values into a standardized data structure. Thus, all methods in <classname>Zend_Locale_Format</classname>
        require a locale in order to parse the input data.
        <note>
            <title>Default "root" Locale</title>
            <para>
                If no locale is specified, then normalization and localization will use the standard "root" locale,
                which might yield unexpected behavior, if the input originated in a different locale, or output for a
                specific locale was expected.
            </para>
        </note>
    </para>

    <sect2 id="zend.locale.number.normalize">

        <title>Number normalization: getNumber($input, Array $options)</title>

        <para>
            There are many
            <ulink url="http://en.wikipedia.org/wiki/Numeral">number systems</ulink>
            different from the common
            <ulink url="http://en.wikipedia.org/wiki/Decimal">decimal system</ulink>
            (e.g. "3.14"). Numbers can be normalized with the <code>getNumber()</code> function to obtain the standard
            decimal representation. for all number-related discussions in this manual,
            <ulink url="http://en.wikipedia.org/wiki/Arabic_numerals">Arabic/European numerals (0,1,2,3,4,5,6,7,8,9)</ulink>
            are implied, unless explicitly stated otherwise. The options array may contain a 'locale' to define grouping
            and decimal characters. The array may also have a 'precision' to truncate excess digits from the result.
        </para>

        <example id="zend.locale.number.normalize.example-1">
            <title>Number normalization</title>
            <programlisting language="php"><![CDATA[
$locale = new Zend_Locale('de_AT');
$number = Zend_Locale_Format::getNumber('13.524,678',
                                        array('locale' => $locale,
                                              'precision' => 3)
                                       );

print $number; // will return 13524.678
]]></programlisting>
        </example>

        <sect3 id="zend.locale.number.normalize.precision">

            <title>Precision and Calculations</title>

            <para>
                Since <code>getNumber($value, array $options = array())</code> can normalize extremely large numbers,
                check the result carefully before using finite precision calculations, such as ordinary PHP math
                operations. For example, <code>if ((string)int_val($number) != $number) { use
                <ulink url="http://www.php.net/bc">BCMath</ulink>
                or
                <ulink url="http://www.php.net/gmp">GMP</ulink>
                </code>. Most PHP installations support the BCMath extension.
            </para>

            <para>
                Also, the precision of the resulting decimal representation can be rounded to a desired length with
                <code>getNumber()</code> with the option <code>'precision'</code>. If no precision is given,
                no rounding occurs. Use only PHP integers to specify the precision.
            </para>

            <para>
                If the resulting decimal representation should be truncated to a desired length instead of rounded
                the option <code>'number_format'</code> can be used instead. Define the length of the decimal
                representation with the desired length of zeros. The result will then not be rounded.
                So if the defined precision within <code>number_format</code> is zero the value "1.6" will
                return "1", not "2. See the example nearby:
            </para>

            <example id="zend.locale.number.normalize.precision.example-1">
                <title>Number normalization with precision</title>
                <programlisting language="php"><![CDATA[
$locale = new Zend_Locale('de_AT');
$number = Zend_Locale_Format::getNumber('13.524,678',
                                        array('precision' => 1,
                                              'locale' => $locale)
                                       );
print $number; // will return 13524.7

$number = Zend_Locale_Format::getNumber('13.524,678',
                                        array('number_format' => '#.00',
                                              'locale' => $locale)
                                       );
print $number; // will return 13524.67
]]></programlisting>
            </example>

        </sect3>

    </sect2>

    <sect2 id="zend.locale.number.localize">

        <title>Number localization</title>

        <para>
            <code>toNumber($value, array $options = array())</code> can localize numbers to the following
            <link linkend="zend.locale.appendix">supported locales</link>
            . This function will return a localized string of the given number in a conventional format for a specific
            locale. The 'number_format' option explicitly specifies a non-default number format for use with
            <code>toNumber()</code>.
        </para>

        <example id="zend.locale.number.localize.example-1">
            <title>Number localization</title>
            <programlisting language="php"><![CDATA[
$locale = new Zend_Locale('de_AT');
$number = Zend_Locale_Format::toNumber(13547.36,
                                       array('locale' => $locale));

// will return 13.547,36
print $number;
]]></programlisting>
        </example>

        <para>
            <note>
                <title>Unlimited length</title>
                <para>
                    <code>toNumber()</code> can localize numbers with unlimited length. It is not related to integer or
                    float limitations.
                </para>
            </note>
        </para>

        <para>
            The same way as within <code>getNumber()</code>, <code>toNumber()</code> handles precision. If no precision
            is given, the complete localized number will be returned.
        </para>

        <example id="zend.locale.number.localize.example-2">
            <title>Number localization with precision</title>
            <programlisting language="php"><![CDATA[
$locale = new Zend_Locale('de_AT');
$number = Zend_Locale_Format::toNumber(13547.3678,
                                       array('precision' => 2,
                                             'locale' => $locale));

// will return 13.547,37
print $number;
]]></programlisting>
        </example>

        <para>
            Using the option 'number_format' a self defined format for generating a number can be defined.
            The format itself has to be given in CLDR format as described below. The locale is used to get
            separation, precision and other number formatting signs from it. German for example defines
            ',' as precision separation and in English the '.' sign is used.
        </para>

        <table id="zend.locale.number.localize.table-1">
            <title>Format tokens for self generated number formats
            </title>
            <tgroup cols="4">
                <thead>
                    <row>
                        <entry>Token</entry>
                        <entry>Description</entry>
                        <entry>Example format</entry>
                        <entry>Generated output</entry>
                    </row>
                </thead>
                <tbody>
                    <row>
                        <entry>#0</entry>
                        <entry>Generates a number without precision and separation</entry>
                        <entry>#0</entry>
                        <entry>1234567</entry>
                    </row>
                    <row>
                        <entry>,</entry>
                        <entry>Generates a separation with the length from separation to next separation or to 0</entry>
                        <entry>#,##0</entry>
                        <entry>1,234,567</entry>
                    </row>
                    <row>
                        <entry>#,##,##0</entry>
                        <entry>Generates a standard separation of 3 and all following separations with 2</entry>
                        <entry>#,##,##0</entry>
                        <entry>12,34,567</entry>
                    </row>
                    <row>
                        <entry>.</entry>
                        <entry>Generates a precision</entry>
                        <entry>#0.#</entry>
                        <entry>1234567.1234</entry>
                    </row>
                    <row>
                        <entry>0</entry>
                        <entry>Generates a precision with a defined length</entry>
                        <entry>#0.00</entry>
                        <entry>1234567.12</entry>
                    </row>
                </tbody>
            </tgroup>
        </table>

        <example id="zend.locale.number.localize.example-3">
            <title>Using a self defined number format</title>
            <programlisting language="php"><![CDATA[
$locale = new Zend_Locale('de_AT');
$number = Zend_Locale_Format::toNumber(13547.3678,
                                       array('number_format' => '#,#0.00',
                                             'locale' => 'de')
                                      );

// will return 1.35.47,36
print $number;

$number = Zend_Locale_Format::toNumber(13547.3,
                                       array('number_format' => '#,##0.00',
                                             'locale' => 'de')
                                       );

// will return 13.547,30
print $number;
]]></programlisting>
        </example>

    </sect2>

    <sect2 id="zend.locale.number.test">

        <title>Number testing</title>

        <para>
            <code>isNumber($value, array $options = array())</code> checks if a given string is a number and returns
            true or false.
        </para>

        <example id="zend.locale.number.test.example-1">
            <title>Number testing</title>
            <programlisting language="php"><![CDATA[
$locale = new Zend_Locale();
if (Zend_Locale_Format::isNumber('13.445,36', array('locale' => 'de_AT')) {
    print "Number";
} else {
    print "not a Number";
}
]]></programlisting>
        </example>

    </sect2>

    <sect2 id="zend.locale.float.normalize">

        <title>Float value normalization</title>

        <para>
            Floating point values can be parsed with the <code>getFloat($value, array $options = array())</code>
            function. A floating point value will be returned.
        </para>

        <example id="zend.locale.float.normalize.example-1">
            <title>Floating point value normalization</title>
            <programlisting language="php"><![CDATA[
$locale = new Zend_Locale('de_AT');
$number = Zend_Locale_Format::getFloat('13.524,678',
                                       array('precision' => 2,
                                             'locale' => $locale)
                                      );

// will return 13524.68
print $number;
]]></programlisting>
        </example>

    </sect2>

    <sect2 id="zend.locale.float.localize">

        <title>Floating point value localization</title>

        <para>
            <code>toFloat()</code> can localize floating point values. This function will return a localized string of
            the given number.
        </para>

        <example id="zend.locale.float.localize.example-1">
            <title>Floating point value localization</title>
            <programlisting language="php"><![CDATA[
$locale = new Zend_Locale('de_AT');
$number = Zend_Locale_Format::toFloat(13547.3655,
                                      array('precision' => 1,
                                            'locale' => $locale)
                                     );

// will return 13.547,4
print $number;
]]></programlisting>
        </example>

    </sect2>

    <sect2 id="zend.locale.float.test">

        <title>Floating point value testing</title>

        <para>
            <code>isFloat($value, array $options = array())</code> checks if a given string is a floating point value
            and returns true or false.
        </para>

        <example id="zend.locale.float.test.example-1">
            <title>Floating point value testing</title>
            <programlisting language="php"><![CDATA[
$locale = new Zend_Locale('de_AT');
if (Zend_Locale_Format::isFloat('13.445,36', array('locale' => $locale)) {
    print "float";
} else {
    print "not a float";
}
]]></programlisting>
        </example>

    </sect2>

    <sect2 id="zend.locale.integer.normalize">

        <title>Integer value normalization</title>

        <para>
            Integer values can be parsed with the <code>getInteger()</code> function. A integer value will be returned.
        </para>

        <example id="zend.locale.integer.normalize.example-1">
            <title>Integer value normalization</title>
            <programlisting language="php"><![CDATA[
$locale = new Zend_Locale('de_AT');
$number = Zend_Locale_Format::getInteger('13.524,678',
                                         array('locale' => $locale));

// will return 13524
print $number;
]]></programlisting>
        </example>

    </sect2>

    <sect2 id="zend.locale.integer.localize">

        <title>Integer point value localization</title>

        <para>
            <code>toInteger($value, array $options = array())</code> can localize integer values. This function will
            return a localized string of the given number.
        </para>

        <example id="zend.locale.integer.localize.example-1">
            <title>Integer value localization</title>
            <programlisting language="php"><![CDATA[
$locale = new Zend_Locale('de_AT');
$number = Zend_Locale_Format::toInteger(13547.3655,
                                        array('locale' => $locale));

// will return 13.547
print $number;
]]></programlisting>
        </example>

    </sect2>

    <sect2 id="zend.locale.integer.test">

        <title>Integer value testing</title>

        <para>
            <code>isInteger($value, array $options = array())</code> checks if a given string is a integer value and
            returns true or false.
        </para>

        <example id="zend.locale.integer.test.example-1">
            <title>Integer value testing</title>
            <programlisting language="php"><![CDATA[
$locale = new Zend_Locale('de_AT');
if (Zend_Locale_Format::isInteger('13.445', array('locale' => $locale)) {
    print "integer";
} else {
    print "not a integer";
}
]]></programlisting>
        </example>

    </sect2>

    <sect2 id="zend.locale.numbersystems">

        <title>Numeral System Conversion</title>

        <para>
            <classname>Zend_Locale_Format::convertNumerals()</classname> converts digits between different
            <ulink url="http://en.wikipedia.org/wiki/Arabic_numerals">numeral systems</ulink>
            , including the standard Arabic/European/Latin numeral system (0,1,2,3,4,5,6,7,8,9), not to be confused with
            <ulink url="http://en.wikipedia.org/wiki/Eastern_Arabic_numerals">Eastern Arabic numerals</ulink>
            sometimes used with the Arabic language to express numerals. Attempts to use an unsupported numeral system
            will result in an exception, to avoid accidentally performing an incorrect conversion due to a spelling
            error. All characters in the input, which are not numerals for the selected numeral system, are copied to
            the output with no conversion provided for unit separator characters. <classname>Zend_Locale</classname>* components
            rely on the data provided by CLDR (see their
            <ulink url="http://unicode.org/cldr/data/diff/supplemental/languages_and_scripts.html?sortby=date">
                list of scripts grouped by language</ulink>).
        </para>

        <para>
            In CLDR and hereafter, the Europena/Latin numerals will
            be referred to as "Latin" or by the assigned 4-letter code "Latn".
            Also, the CLDR refers to this numeral systems as "scripts".
        </para>

        <para>
            Suppose a web form collected a numeric input expressed using Eastern Arabic digits "١‎٠٠".
            Most software and PHP functions expect input using Arabic numerals. Fortunately, converting this input
            to its equivalent Latin numerals "100" requires little effort using
            <code>convertNumerals($inputNumeralString, $sourceNumeralSystem, $destNumeralSystem)</code>
            , which returns the <code>$input</code> with numerals in the script <code>$sourceNumeralSystem</code>
            converted to the script <code>$destNumeralSystem</code>.
        </para>

        <example id="zend.locale.numbersystems.example-1">
            <title>Converting numerals from Eastern Arabic scripts to European/Latin scripts</title>
            <programlisting language="php"><![CDATA[
$arabicScript = "١‎٠٠";   // Arabic for "100" (one hundred)
$latinScript = Zend_Locale_Format::convertNumerals($arabicScript,
                                                   'Arab',
                                                   'Latn');

print "\nOriginal:   " . $arabicScript;
print "\nNormalized: " . $latinScript;
]]></programlisting>
        </example>

        <para>
            Similarly, any of the supported numeral systems may be converted to any other supported numeral system.
        </para>

        <example id="zend.locale.numbersystems.example-2">
            <title>Converting numerals from Latin script to Eastern Arabic script</title>
            <programlisting language="php"><![CDATA[
$latinScript = '123';
$arabicScript = Zend_Locale_Format::convertNumerals($latinScript,
                                                    'Latn',
                                                    'Arab');

print "\nOriginal:  " . $latinScript;
print "\nLocalized: " . $arabicScript;
]]></programlisting>
        </example>

        <example id="zend.locale.numbersystems.example-3">
            <title>Getting 4 letter CLDR script code using a native-language name of the script</title>
            <programlisting language="php"><![CDATA[
function getScriptCode($scriptName, $locale)
{
    $scripts2names = Zend_Locale_Data::getList($locale, 'script');
    $names2scripts = array_flip($scripts2names);
    return $names2scripts[$scriptName];
}
echo getScriptCode('Latin', 'en'); // outputs "Latn"
echo getScriptCode('Tamil', 'en'); // outputs "Taml"
echo getScriptCode('tamoul', 'fr'); // outputs "Taml"
]]></programlisting>
        </example>

        <para>
            For a list of supported numeral systems call
            <methodname>Zend_Locale::getTranslationList('numberingsystem', 'en')</methodname>.
        </para>

    </sect2>

</sect1>
<!--
vim:se ts=4 sw=4 et:
-->