NestedNativeArray

NestedNativeArray class is an implementation of the Translate Adapter interface that uses a nested array as the translation source.

Usage example:

$interpolator = new InterpolatorFactory();
$options = [
    'content' => [
        'en' => [
            'welcome' => 'Welcome to our website!',
            'goodbye' => 'Goodbye!',
        ],
        'fr' => [
            'welcome' => 'Bienvenue sur notre site web!',
            'goodbye' => 'Au revoir!',
        ],
    ],
    'triggerError' => false,
    'delimiter' => '.',
];

$translator = new NestedNativeArray($interpolator, $options);

// Check if translation exists
$translator->exists('en.welcome'); // returns true

// Get translated string
$translator->query('fr.goodbye'); // returns 'Au revoir!'

// Get translated string with placeholders
$translator->query('en.welcome', ['name' => 'John']); // returns 'Welcome to our website, John!'

• Full name: \Zemit\Translate\Adapter\NestedNativeArray
• Parent class: AbstractAdapter
• This class implements: \ArrayAccess

Properties

translate

Translation array.

private array $translate

triggerError

private bool $triggerError

delimiter

Sets the value of the delimiter.

protected string $delimiter

Methods

__construct

Zemit\Translate\Adapter\NestedNativeArray constructor

public __construct(\Phalcon\Translate\InterpolatorFactory $interpolator, array $options): mixed

Parameters:

exists

Returns whether a translation exists for the given index

public exists(string $index): bool

• Warning: this method is deprecated. This means that this method will likely be removed in a future version.

Parameters:

Return Value:

True if a translation exists for the index, false otherwise

See Also:

• \Zemit\Translate\Adapter\has() -

has

Returns true if the translation for the given index exists, false otherwise.

public has(string $index): bool

Parameters:

Return Value:

Returns true if the translation for the given index exists, false otherwise.

notFound

Returns the index if translation key is not found Throws exception if triggerError is enabled and translation key is not found

public notFound(string $index): string

Parameters:

Return Value:

Returns the index

Throws:

Throws exception if triggerError is enabled and translation key is not found

• Exception

query

Queries for a translated string based on the given translate key and optional placeholders.

public query(string $translateKey, array $placeholders = []): string

Parameters:

Return Value:

The translated string or the not found string if the translate key is not found.

Throws:

Throws exception if triggerError is enabled and translation key is not found

• Exception

toArray

Converts the translate data to an array.

public toArray(): array

Return Value:

The translate data as an array.