FileAccess Orion

IcuResFileLoader
in package
implements LoaderInterface

IcuResFileLoader loads translations from a resource bundle.

Tags
author

stealth35

Interfaces, Classes, Traits and Enums

LoaderInterface
LoaderInterface is the interface implemented by all translation loaders.

Table of Contents

load()  : MessageCatalogue
Loads a locale.
flatten()  : array<string|int, mixed>
Flattens an ResourceBundle.

Methods

load()

Loads a locale.

public load(mixed $resource, mixed $locale[, mixed $domain = 'messages' ]) : MessageCatalogue
Parameters
$resource : mixed

A resource

$locale : mixed

A locale

$domain : mixed = 'messages'

The domain

Return values
MessageCatalogue —

A MessageCatalogue instance

flatten()

Flattens an ResourceBundle.

protected flatten(ResourceBundle $rb[, array<string|int, mixed> &$messages = [] ][, string $path = null ]) : array<string|int, mixed>

The scheme used is: key { key2 { key3 { "value" } } } Becomes: 'key.key2.key3' => 'value'

This function takes an array by reference and will modify it

Parameters
$rb : ResourceBundle

The ResourceBundle that will be flattened

$messages : array<string|int, mixed> = []

Used internally for recursive calls

$path : string = null

Current path being parsed, used internally for recursive calls

Return values
array<string|int, mixed> —

the flattened ResourceBundle

Search results