General.md

General

This part coverts units and list formatting.

Unicode Reference

---

The documentation is divided into the following parts, mimicking Unicode's documentation:

• Part 1: Core (languages, locales, basic structure)
• Part 2: General (display names & transforms, etc.)
• Part 3: Numbers (number & currency formatting)
• Part 4: Dates (date, time, time zone formatting)
• Part 5: Collation (sorting, searching, grouping)
• Part 6: Supplemental (supplemental data)

---

Units

Quantities of units such as years, months, days, hours, minutes and seconds can be formatted— for example, in English, "1 day" or "3 days". It's easy to make use of this functionality via a locale's units. Many units are available.

<?php

/* @var ICanBoogie\CLDR\Repository $cldr */

$units = $cldr->locale_for('en')->units;

echo $units->duration_hour->name;                   // hours
echo $units->duration_hour->short_name;             // h
echo $units->duration_hour(1);                      // 1 hour
echo $units->duration_hour(23);                     // 23 hours
echo $units->duration_hour(23)->as_short;           // 23 hr
echo $units->duration_hour(23)->as_narrow;          // 23h

Reference

Compound units

Combination of units, such as miles per hour or liters per second, can be created. Some units already have 'precomputed' forms, such as kilometer_per_hour; where such units exist, they should be used in preference.

<?php

/* @var ICanBoogie\CLDR\Repository $cldr */

$units = $cldr->locale_for('en')->units;

echo $units->volume_liter(12.345)->per($units->duration_hour);              // 12.345 liters per hour
echo $units->volume_liter(12.345)->per($units->duration_hour)->as_short;    // 12.345 Lph
echo $units->volume_liter(12.345)->per($units->duration_hour)->as_narrow;   // 12.345l/h

Reference

Unit Sequences (Mixed Units)

Units may be used in composed sequences, such as 5° 30m for 5 degrees 30 minutes, or 3′ 2″. For that purpose, the appropriate width can be used to compose the units in a sequence.

<?php

/* @var ICanBoogie\CLDR\Repository $repository */

$units = $repository->locale_for('en')->units;

$units->sequence
    ->angle_degree(5)
    ->duration_minute(30)
    ->as_long;
    // 5 degrees, 30 minutes

$units->sequence
    ->length_foot(3)
    ->length_inch(2)
    ->as_narrow;
    // 3′ 2″

$units = $repository->locale_for('fr')->units;

$units->sequence
    ->duration_hour(12)
    ->duration_minute(34)
    ->duration_second(45)
    ->as_long;
    // 12 heures, 34 minutes et 56 secondes

$units->sequence
    ->duration_hour(12)
    ->duration_minute(34)
    ->duration_second(45)
    ->as_short;
    // 12 h, 34 min et 56 s

$units->sequence
    ->duration_hour(12)
    ->duration_minute(34)
    ->duration_second(45)
    ->as_narrow;
    // 12h 34m 56s

Reference

List formatting

Use the format_list() method of a locale to format a variable-length list of items:

<?php

/* @var ICanBoogie\CLDR\Repository $cldr */

# You can format a list in English
$en = $cldr->locale_for('en');

$en->format_list([ "Monday" ]);
// Monday
$en->format_list([ "Monday", "Tuesday" ]);
// Monday and Tuesday
$en->format_list([ "Monday", "Tuesday", "Wednesday" ]);
// Monday, Tuesday, and Wednesday
$en->format_list([ "Monday", "Tuesday", "Friday", "Thursday" ]);
// Monday, Tuesday, Wednesday, and Thursday

# You can format a list in French
$fr = $cldr->for_locale('fr');

$fr->format_list([ "lundi" ]);
// lundi
$fr->format_list([ "lundi", "mardi" ]);
// lundi et mardi
$fr->format_list([ "lundi", "mardi", "mercredi" ]);
// lundi, mardi et mercredi
$fr->format_list([ "lundi", "mardi", "mercredi", "jeudi" ]);
// lundi, mardi, jeudi et mercredi

Alternatively, you can get a list formatter using the list_formatter property:

<?php

/* @var \ICanBoogie\CLDR\Core\Locale $locate */

$list_formatter = $locale->list_formatter;
$list_formatter->format([ "Monday", "Tuesday", "Wednesday" ]);
// Monday, Tuesday, and Wednesday