1. interface
  2. Concrete
  3. \
  4. Core
  5. \
  6. Localization
  7. \
  8. Translation
  9. \
  10. Remote
  11. \
  12. ProviderInterface

ProviderInterface

interface ProviderInterface (View source)

Methods

Stats[]
getAvailableCoreStats(string $coreVersion, int|null $progressLimit = null)

List the available translations for a specific core version.

Stats
getCoreStats(string $coreVersion, string $localeID, int|null $progressLimit = null)

Get core translations stats for a specific locale ID.

Stats[]
getAvailablePackageStats(string $packageHandle, string $packageVersion, int|null $progressLimit = null)

List the available translations for a specific package version.

Stats
getPackageStats(string $packageHandle, string $packageVersion, $localeID, $progressLimit = null)

Get package translations stats for a specific locale ID.

string
fetchCoreTranslations(string $coreVersion, string $localeID, string $formatHandle = 'mo')

Fetch the translations for the concrete5 core.

string
fetchPackageTranslations(string $packageHandle, string $packageVersion, string $localeID, string $formatHandle = 'mo')

Fetch the translations for a package.

Translations
fillTranslations(Translations $translations)

Fill-in already known translations.

Details

at line 16
Stats[] getAvailableCoreStats(string $coreVersion, int|null $progressLimit = null)

List the available translations for a specific core version.

Parameters

string $coreVersion

The version of the concrete5 core
int|null $progressLimit

A custom progress limit (from 0 - no translations at all - to 100 - all strings are translated)

Return Value

Stats[]

Array keys are the locale IDs, values are Stats instances

at line 27
Stats getCoreStats(string $coreVersion, string $localeID, int|null $progressLimit = null)

Get core translations stats for a specific locale ID.

Parameters

string $coreVersion

The version of the concrete5 core
string $localeID
int|null $progressLimit

A custom progress limit (from 0 - no translations at all - to 100 - all strings are translated)

Return Value

Stats

at line 38
Stats[] getAvailablePackageStats(string $packageHandle, string $packageVersion, int|null $progressLimit = null)

List the available translations for a specific package version.

Parameters

string $packageHandle

The handle of the package
string $packageVersion

The version of the package
int|null $progressLimit

A custom progress limit (from 0 - no translations at all - to 100 - all strings are translated)

Return Value

Stats[]

Array keys are the locale IDs, values are Stats instances

at line 48
Stats getPackageStats(string $packageHandle, string $packageVersion, $localeID, $progressLimit = null)

Get package translations stats for a specific locale ID.

Parameters

string $packageHandle

The handle of the package
string $packageVersion

The version of the package
$localeID
$progressLimit

Return Value

Stats

at line 59
string fetchCoreTranslations(string $coreVersion, string $localeID, string $formatHandle = 'mo')

Fetch the translations for the concrete5 core.

Parameters

string $coreVersion

The version of the concrete5 core
string $localeID

The locale identifier
string $formatHandle

The handle of the format of the translations to be fetched

Return Value

string

at line 71
string fetchPackageTranslations(string $packageHandle, string $packageVersion, string $localeID, string $formatHandle = 'mo')

Fetch the translations for a package.

Parameters

string $packageHandle

The handle of the package
string $packageVersion

The version of the package
string $localeID

The locale identifier
string $formatHandle

The handle of the format of the translations to be fetched

Return Value

string

at line 80
Translations fillTranslations(Translations $translations)

Fill-in already known translations.

Parameters

Translations $translations

Return Value

Translations