EXT: Static Info Tables¶

Read only¶

The tables are static, i.e. they are not intended to be updated on a site using the extension. Therefore, the tables are normally configured as read-only.

UTF-8 encoding¶

The tables are encoded with UTF-8.

Non-removal of deleted entries¶

In order to ensure that the value of the uid field of an entry is never changed and that relationships established between tables on the basis of the uid fields, entries marked as deleted should never be removed from the tables.

Localization by language pack¶

The tables provided by this extension do not include labels in any language other than English, except for some labels in the local language of the entity. Labels in other languages are provided by extra extensions, called language packs, that extend the basic strutures provided by this extension.

Territory (static_territories)¶

This table provide data about territories or macro-geographical regions as defined by the UN geoscheme ( http://unstats.un.org/unsd/methods/m49/m49regin.htm ).

The data is hierarchical organized which means the fields tr_parent_iso_nrand tr_parent_territory_uid refer to the parent territory containing the territory defined by the current entry.

A country has a reference to the territory in which the country is contained.

CREATE TABLE static_territories (
  uid int(11) unsigned NOT NULL auto_increment,
  pid int(11) unsigned NOT NULL default '0',
  deleted tinyint(4) NOT NULL default '0',
  tr_iso_nr int(11) unsigned NOT NULL default '0',
  tr_parent_territory_uid int(11) NOT NULL default '0',
  tr_parent_iso_nr int(11) unsigned NOT NULL default '0',
  tr_name_en varchar(50) NOT NULL default '',
  PRIMARY KEY (uid)
);

Country (static_countries)¶

This table provides data about countries based on ISO 3166-1 (see http://www.iso.org/iso/country_codes);

CREATE TABLE static_countries (
  uid int(11) unsigned NOT NULL auto_increment,
  pid int(11) unsigned NOT NULL default '0',
  deleted tinyint(4) NOT NULL default '0',
  cn_iso_2 char(2) NOT NULL default '',
  cn_iso_3 char(3) NOT NULL default '',
  cn_iso_nr int(11) unsigned NOT NULL default '0',
  cn_parent_territory_uid int(11) NOT NULL default '0',
  cn_parent_tr_iso_nr int(11) unsigned NOT NULL default '0',
  cn_official_name_local varchar(128) NOT NULL default '',
  cn_official_name_en varchar(128) NOT NULL default '',
  cn_capital varchar(45) NOT NULL default '',
  cn_tldomain char(2) NOT NULL default '',
  cn_currency_uid int(11) NOT NULL default '0',
  cn_currency_iso_3 char(3) NOT NULL default '',
  cn_currency_iso_nr int(10) unsigned NOT NULL default '0',
  cn_phone int(10) unsigned NOT NULL default '0',
  cn_eu_member tinyint(3) unsigned NOT NULL default '0',
  cn_uno_member tinyint(3) unsigned NOT NULL default '0',
  cn_address_format tinyint(3) unsigned NOT NULL default '0',
  cn_zone_flag tinyint(4) NOT NULL default '0',
  cn_short_local varchar(70) NOT NULL default '',
  cn_short_en varchar(50) NOT NULL default '',
  cn_country_zones int(11) NOT NULL default '0',
  PRIMARY KEY (uid)
);

Local names (cn_official_name_local and cn_short_local) are in the official languages of the countries. Appropriate Unicode fonts are required to display all entries on a client computer.

Address formats are described in the section Address Formats of the configuration section.

Country Zone (static_country_zones)¶

This table provides data about country subdivisions, provinces, departments or states based on ISO 3166-2.

CREATE TABLE static_country_zones (
  uid int(11) unsigned NOT NULL auto_increment,
  pid int(11) unsigned NOT NULL default '0',
  deleted tinyint(4) NOT NULL default '0',
  zn_country_iso_2 char(2) NOT NULL default '',
  zn_country_iso_3 char(3) NOT NULL default '',
  zn_country_iso_nr int(11) unsigned NOT NULL default '0',
  zn_code varchar(45) NOT NULL default '',
  zn_name_local varchar(128) NOT NULL default '',
  zn_name_en varchar(50) NOT NULL default '',
  zn_country_uid int(11) NOT NULL default '0',
  zn_country_table tinytext,
  PRIMARY KEY (uid)
);

Currency (static_currencies)¶

This table provides data about currencies based on standard ISO 4217.

CREATE TABLE static_currencies (
  uid int(11) unsigned NOT NULL auto_increment,
  pid int(11) unsigned NOT NULL default '0',
  deleted tinyint(4) NOT NULL default '0',
  cu_iso_3 char(3) NOT NULL default '',
  cu_iso_nr int(11) unsigned NOT NULL default '0',
  cu_name_en varchar(50) NOT NULL default '',
  cu_symbol_left varchar(12) NOT NULL default '',
  cu_symbol_right varchar(12) NOT NULL default '',
  cu_thousands_point char(1) NOT NULL default '',
  cu_decimal_point char(1) NOT NULL default '',
  cu_decimal_digits tinyint(3) unsigned NOT NULL default '0',
  cu_sub_name_en varchar(20) NOT NULL default '',
  cu_sub_divisor int(11) NOT NULL default '1',
  cu_sub_symbol_left varchar(12) NOT NULL default '',
  cu_sub_symbol_right varchar(12) NOT NULL default '',
  PRIMARY KEY (uid),
  KEY parent (pid)
);

Language (static_languages)¶

This table provides data about languages based on standards ISO 639-1 and RFC 4646 (see http://www.faqs.org/rfcs/rfc4646.html).

CREATE TABLE static_languages (
  uid int(11) unsigned NOT NULL auto_increment,
  pid int(11) unsigned NOT NULL default '0',
  deleted tinyint(4) NOT NULL default '0',
  lg_iso_2 char(2) NOT NULL default '',
  lg_name_local varchar(99) NOT NULL default '',
  lg_name_en varchar(50) NOT NULL default '',
  lg_typo3 char(2) NOT NULL default '',
  lg_country_iso_2 char(2) NOT NULL default '',
  lg_collate_locale varchar(5) NOT NULL default '',
  lg_sacred tinyint(3) unsigned NOT NULL default '0',
  lg_constructed tinyint(3) unsigned NOT NULL default '0',
  PRIMARY KEY (uid),
  KEY parent (pid)
);

The local name ( lg_name_local) of a language is in the language itself. Appropriate Unicode fonts are required to display all entries on a client computer.

Territory¶

The class is named: SJBRStaticInfoTablesDomainModelTerritory

The following properties have a getter and a setter:

• deleted (whether or not the terrritory was removed from the UN standard)
• nameEn (English name)
• nameLocalized (localized name of the territory, non-persistent)
• parentTerritoryUnCodeNumber (UN code of containing territory)
• unCodeNumber (UN code)

Country¶

The class is named: SJBRStaticInfoTablesDomainModelCountry

The following properties have a getter and a setter:

• addressFormat
• capitalCity (name of captital city)
• countryZones (country subdivisions of the country)
• currencyIsoCodeA3
• currencyIsoCodeNumber
• deleted (whether or not the country was removed from the ISO standard)
• euMember (whether or not the country is a member of the European Union)
• additional method: isEuMember()
• isoCodeA2
• isoCodeA3
• isoCodeNumber
• nameLocalized (localized name of the country, non-persistent)
• officialNameEn (official English name)
• officialNameLocal (official name of the country in local language and local script)
• parentTerritoryUnCodeNumber (UN number of the territory in which the country is located)
• phonePrefix (international phone prefix for the country)
• shortNameEn (short English name)
• shortNameLocal (short name of the country in local language and local script)
• topLevelDomain (Internet top level domain of the country)
• unMember (whether or not the country is a member of the UNO)
• additional method: isUnMember()
• zoneFlag (whether or not the country has subdivisions)

CountryZone¶

The class is named: SJBRStaticInfoTablesDomainModelCountryZone

The following properties have a getter and a setter:

• countryIsoCodeA2
• countryIsoCodeA3
• countryIsoCodeNumber
• deleted (whether or not the country zone was removed from the ISO standard)
• isoCode
• localName (name of the country zone in local language and local script)
• nameEn (English name of the country zone)
• nameLocalized (localized name of the country zone, non-persistent)

Currency¶

The class is named: SJBRStaticInfoTablesDomainModelCurrency

The following properties have a getter and a setter:

• decimalDigits (number of decimals to be shown when an amount is presented in this currency)
• decimalPoint (character to be shown in front of the decimals when an amount is presented in this currency)
• deleted (whether or not the currency was removed from the ISO standard)
• divisor (divisor used to obtain the subdivision of the currency)
• isoCodeA3
• isoCodeNumber
• nameEn (English name of the currency)
• nameLocalized (localized name of the currency, non-persistent)
• subdivisionNameEn (English name of the subdivision of the currency)
• subdivisionSymbolLeft (symbol to be shown to the left of an amount stated in units of the subdivision of the currency)
• subdivisionSymbolRight (symbol to be shown to the right of an amount stated in units of the subdivision of the currency)
• symbolLeft (symbol to be shown to the left of an amount stated in units of the currency)
• symbolRight (symbol to be shown to the right of an amount stated in units of the currency)
• thousandsPoint (Character to be used between every group of thousands of an amount stated in units of this currency)

Language¶

The class is named: SJBRStaticInfoTablesDomainModelLanguage

The following properties have a getter and a setter:

• collatingLocale
• constructedLanguage (whether or not the language is a constructed language)
• additional method: isConstructedLanguage()
• countryIsoCodeA2 (country code as two digit string that identifies this language as a variant of the language identified by property isoCodeA2)
• deleted (whether or not the language was removed from the ISO standard)
• isoCodeA2
• localName (name of the language in the language itself)
• nameEn (English name of the language)
• nameLocalized (localized name of the language, non-persistent)
• typo3Code (deprecated)
• sacredLanguage (whether or not the language is a sacred language)
• additional method: isSacredLanguage()
• typo3Code (deprecated)

Additional properties¶

Language packs will add properties and corresponding getters and setters to the domain model objects in the following way.

A language pack is identified by a two-letter ISO language code (e.g. de), possibly followed by an underscore and a two-letter ISO country code (e.g. de_AT).

Let XX stand for the camelization of the identifier of the language pack (e.g. De or DeAt), the following properties will be added to the domain model objects:

• SJBRStaticInfoTablesDomainModelTerritory: nameXX
• SJBRStaticInfoTablesDomainModelCountry: shortNameXX
• SJBRStaticInfoTablesDomainModelCountryZone: nameXX
• SJBRStaticInfoTablesDomainModelCurrency: nameXX and subdivisionNameXX
• SJBRStaticInfoTablesDomainModelLanguage: nameXX

Localization property nameLocalized¶

The property nameLocalized is available on each of the static entities of the domain model. The property is derived from the available naming properties and is non-persistent.

This method getNameLocalized() applies the localization rules as specified by the current TYPO3 configuration, using any available localized names as provided by the installed language packs.

Abstract repository¶

The following methods are available on the repository of all static entities.

Territory¶

The repository class is named: SJBRStaticInfoTablesDomainRepositoryTerritory

The following methods are available:

Country¶

The repository class is named: SJBRStaticInfoTablesDomainRepositoryCountry

The following methods are available:

CountryZone¶

The repository class is named:SJBRStaticInfoTablesDomainRepositoryCountryZone

The following methods are available:

Currency¶

The repository class is named: SJBRStaticInfoTablesDomainRepositoryCurrency

The following method is available:

Language¶

The repository class is named: SJBRStaticInfoTablesDomainRepositoryLanguage

The following methods are available:

Adding a country select field to a form¶

If you want to insert a country select box into a form, you first have to add a Fluid select view helper to your Fluid template:

<f:form.select name="country" options="{countries}" optionLabelField="nameLocalized" sortByOptionLabel="1" />

Using property “nameLocalized” as label will display the country names is the language of the current page.

In the script of the controller class, you then need to inject the Country repository:

/**
 * @var \SJBR\StaticInfoTables\Domain\Repository\CountryRepository
 */
 protected $countryRepository;

/**
 * Dependency injection of the Country Repository
 *
 * @param \SJBR\StaticInfoTables\Domain\Repository\CountryRepository $countryRepository
 * @return void
 */
 public function injectCountryRepository(\SJBR\StaticInfoTables\Domain\Repository\CountryRepository $countryRepository) {
        $this->countryRepository = $countryRepository;
}

Finally, your action method needs to fill in the countries:

public function myNewAction() {
        $countries = $this->countryRepository->findAll();
        $this->view->assign('countries', $countries);
}

Using the select View Helper¶

Alternatively, the extension provides a viewHelper to insert a select field on a form.

Default usage:

{namespace s=SJBR\StaticInfoTables\ViewHelpers}
<s:form.select name="staticInfoTablesTestCountry" staticInfoTable="country" options="{}" />
<s:form.select name="staticInfoTablesTestLanguage" staticInfoTable="language" options="{}" />
<s:form.select name="staticInfoTablesTestTerritory" staticInfoTable="territory" options="{}" />
<s:form.select name="staticInfoTablesTestCurrency" staticInfoTable="currency" options="{}" />
<s:form.select name="staticInfoTablesTestCountryZones" staticInfoTable="countryZone" options="{}" />

Optional usage:

<s:form.select name="staticInfoTablesTestCountry" id="staticInfoTablesTestCountry" staticInfoTable="country" options="{}" optionLabelField="isoCodeA2" />
<s:form.select name="staticInfoTablesTestCountry" id="staticInfoTablesTestCountry" staticInfoTable="country" options="{}" optionLabelField="capitalCity" />

Subselect usage: (only CountryZones of Germany)

<s:form.select name="staticInfoTablesTestCountryZones" id="staticInfoTablesTestCountryZones" staticInfoTable="countryZone" options="{}" staticInfoTableSubselect="{country: 54}" />

Further examples¶

You may find further examples in the source code of the test form included in the backend module of this extension.

Class initialization¶

The following example statements will instantiate and initialize the class:

$this->staticInfo = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('SJBR\\StaticInfoTables\\PiBaseApi');
if ($this->staticInfo->needsInit()) {
        $this->staticInfo->init();
}

Method init() will initialize:

• the language of display: using the TypoScript template config.language property;
• the default currency used to format amounts: using the configured currencyCode;
• defaults for selected values in drop-down lists: using the configured countryCode, countryZoneCode, currencyCode and languageCode.

Getting a localized name¶

Each of the following example statements will return the name of some entity given its code. The name will be in the language specified by the TypoScript config.language property.

$this->staticInfo->getStaticInfoName('COUNTRIES', $countryCode);
$this->staticInfo->getStaticInfoName('SUBDIVISIONS', $zoneCode, $countryCode);
$this->staticInfo->getStaticInfoName('CURRENCIES', $currencyCode);
$this->staticInfo->getStaticInfoName('LANGUAGES', $languageCode, '', '', $self);

In the case of LANGUAGES, if $self is set to 1, the name of the language will be returned in the language itself.

See the source code for a description of the parameters.

Creating a localized drop-down selector¶

Each of the following example statements will return a string of <select> and <option> HTML tags to display a drop-down selector of countries, country subdivisions, currencies or languages. The drop- down selector will be produced in the language specified by the TS config.language property.

$this->staticInfo->buildStaticInfoSelector('COUNTRIES', $fieldName, $CSSClassName, $selectedCountryCode, '', $submitFlag, $id, $title, §where, $lang, $local);
$this->staticInfo->buildStaticInfoSelector('SUBDIVISIONS',  $fieldName, $CSSClassName, $selectedZoneCode, $countryCode, $submitFlag, $id, $title);
$this->staticInfo->buildStaticInfoSelector('CURRENCIES', $fieldName, $CSSClassName, $selectedCurrencyCode, '', $submitFlag, $id, $title);
$this->staticInfo->buildStaticInfoSelector('LANGUAGES', $fieldName, $CSSClassName, $selectedLanguageCode, '', $submitFlag, $id, $title);

See the source code for a description of these and other parameters.

Note that the entries of the drop-down selector are sorted using the current locale. If the front end page is using utf-8 encoding (config.metaCharset = utf-8), then the locale should be fully qualified; for example: config.locale_all = fr_CA.UTF-8.

Formating an amount¶

The following statement will return the amount $amount formated for display in the default currency or in the currency specified in the previously called loadCurrencyInfo method.

$formatedAmount = $this->staticInfo->formatAmount($amount);

Loading an alternate currency¶

The currency to be used to format amounts may be overridden using method loadCurrencyInfo

$this->staticInfo->loadCurrencyInfo($currencyCode);

where $currencyCode is the ISO alpha-3 code (cu_iso_3) of some currency.

The loaded currency will be effective until the same method is called again with a different currency code.

Method init() loads the default currency.

Formating an address¶

The following statement will return an address formated for display according to the address format specified for the country in the static_countries table (cn_address_format).

$formatedAddress = $this->staticInfo->formatAddress($delim, $streetAddress, $city, $zip, $subdivisionCode, $countryCode);

where $delim will often be chr(10), $subdivisionCode is country subdivision code, and $countryCode is a ISO alpha-3 country code.

Getting country info¶

This method is deprecated and will be removed in version 6.2. Use the methods provided by SJBRStaticInfoTablesDomainRepositoryCountryRepository.

You can get the info for different countries by applying the parameters you have obtained from a FE edit field.

$countryArray = tx_staticinfotables_div::fetchCountries($input['country'], $input['countryISO2'], $input['countryISO3'], $input['countryISONr']);

where the first parameter may be the text of the country in English or the local language and only parts of it. The fitting languages will be guessed by the input text.

((generated))¶

currencyCode¶

countryCode¶

countriesAllowed¶

countriesAllowed = DEU,AUT,CHE

countryZoneCode¶

languageCode¶

onChangeAttribute¶