---
title: "Phalcon Translate"
version: "5.20"
---
> Documentation Index
> Fetch the complete documentation index at: https://docs.phalcon.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Phalcon Translate
:::info[NOTE]
All classes are prefixed with `Phalcon`
:::
## Translate\Adapter\AbstractAdapter
Abstract
@implements ArrayAccess<string, string>
- **`Phalcon\Translate\Adapter\AbstractAdapter`** - implements [`Phalcon\Translate\Adapter\AdapterInterface`](#translateadapteradapterinterface), `\ArrayAccess`
- [`Phalcon\Translate\Adapter\Csv`](#translateadaptercsv)
- [`Phalcon\Translate\Adapter\Gettext`](#translateadaptergettext)
- [`Phalcon\Translate\Adapter\NativeArray`](#translateadapternativearray)
`ArrayAccess` · `Phalcon\Contracts\Translate\TranslateTypes` · `Phalcon\Translate\Exception` · `Phalcon\Translate\Exceptions\ImmutableObject` · `Phalcon\Translate\Exceptions\KeyNotFound` · `Phalcon\Translate\InterpolatorFactory` · `Phalcon\Translate\Interpolator\InterpolatorInterface`
### Method Summary
AbstractAdapter constructor.
Returns the translation string of the given key (alias of method 't')
Whenever a key is not found this method will be called
Check whether a translation key exists
Returns the translation related to the given key
Sets a translation value
Unsets a translation from the dictionary
Returns the translation string of the given key
Replaces placeholders by the values passed
### Properties
### Methods
__construct()
```php
public function __construct(
InterpolatorFactory $interpolatorFactory,
array $options = []
);
```
AbstractAdapter constructor.
_()
```php
public function _(
string $translateKey,
array $placeholders = []
): string;
```
Returns the translation string of the given key (alias of method 't')
notFound()
```php
public function notFound( string $index ): string;
```
Whenever a key is not found this method will be called
offsetExists()
```php
public function offsetExists( mixed $offset ): bool;
```
Check whether a translation key exists
offsetGet()
```php
public function offsetGet( mixed $offset ): string;
```
Returns the translation related to the given key
offsetSet()
```php
public function offsetSet(
mixed $offset,
mixed $value
): void;
```
Sets a translation value
offsetUnset()
```php
public function offsetUnset( mixed $offset ): void;
```
Unsets a translation from the dictionary
t()
```php
public function t(
string $translateKey,
array $placeholders = []
): string;
```
Returns the translation string of the given key
replacePlaceholders()
```php
protected function replacePlaceholders(
string $translation,
array $placeholders = []
): string;
```
Replaces placeholders by the values passed
## Translate\Adapter\AdapterInterface
Interface
Phalcon\Translate\Adapter\AdapterInterface
Interface for Phalcon\Translate adapters
- **`Phalcon\Translate\Adapter\AdapterInterface`**
### Method Summary
Check whether is defined a translation key in the internal array
Returns the translation related to the given key
Returns the translation string of the given key
### Methods
has()
```php
public function has( string $index ): bool;
```
Check whether is defined a translation key in the internal array
query()
```php
public function query(
string $translateKey,
array $placeholders = []
): string;
```
Returns the translation related to the given key
Missing-key semantics differ per adapter:
| Adapter | Missing key returns | Strict mode (triggerError) |
| ----------- | ------------------------- | -------------------------- |
| NativeArray | the key, not interpolated | yes |
| Csv | the key, interpolated | yes |
| Gettext | the msgid (gettext) | yes |
With strict mode enabled (the `triggerError` option) a missing key
throws `KeyNotFound` instead of falling back.
t()
```php
public function t(
string $translateKey,
array $placeholders = []
): string;
```
Returns the translation string of the given key
## Translate\Adapter\Csv
Class
- [`Phalcon\Translate\Adapter\AbstractAdapter`](#translateadapterabstractadapter)
- **`Phalcon\Translate\Adapter\Csv`**
`Phalcon\Contracts\Translate\TranslateTypes` · `Phalcon\Traits\Php\FileTrait` · `Phalcon\Translate\Exception` · `Phalcon\Translate\Exceptions\FileOpenError` · `Phalcon\Translate\Exceptions\MissingRequiredParameter` · `Phalcon\Translate\InterpolatorFactory`
### Method Summary
Csv constructor.
Check whether is defined a translation key in the internal array
Check whether is defined a translation key in the internal array
Returns the translation related to the given key
Returns the internal array
### Properties
### Methods
__construct()
```php
public function __construct(
InterpolatorFactory $interpolator,
array $options
);
```
Csv constructor.
exists()
```php
public function exists( string $index ): bool;
```
Check whether is defined a translation key in the internal array
has()
```php
public function has( string $index ): bool;
```
Check whether is defined a translation key in the internal array
query()
```php
public function query(
string $translateKey,
array $placeholders = []
): string;
```
Returns the translation related to the given key
toArray()
```php
public function toArray(): array;
```
Returns the internal array
## Translate\Adapter\Gettext
Class
Phalcon\Translate\Adapter\Gettext
```php
use Phalcon\Translate\Adapter\Gettext;
$adapter = new Gettext(
[
"locale" => "de_DE.UTF-8",
"defaultDomain" => "translations",
"directory" => "/path/to/application/locales",
"category" => LC_MESSAGES,
]
);
```
Allows translations using gettext
- [`Phalcon\Translate\Adapter\AbstractAdapter`](#translateadapterabstractadapter)
- **`Phalcon\Translate\Adapter\Gettext`**
`Phalcon\Contracts\Translate\TranslateTypes` · `Phalcon\Traits\Php\InfoTrait` · `Phalcon\Translate\Exception` · `Phalcon\Translate\Exceptions\MissingGettextExtension` · `Phalcon\Translate\Exceptions\MissingRequiredParameter` · `Phalcon\Translate\InterpolatorFactory`
### Method Summary
Gettext constructor.
Check whether is defined a translation key in the internal array
Check whether is defined a translation key in the internal array
The plural version of gettext().
Returns the translation related to the given key.
Sets the default domain
Sets the domain default to search within when calls are made to gettext()
Sets the path for a domain
Changes the current domain (i.e. the translation file)
Sets locale information
Gets default options
Validator for constructor
### Properties
### Methods
__construct()
```php
public function __construct(
InterpolatorFactory $interpolator,
array $options
);
```
Gettext constructor.
exists()
```php
public function exists( string $index ): bool;
```
Check whether is defined a translation key in the internal array
getCategory()
```php
public function getCategory(): int;
```
getDefaultDomain()
```php
public function getDefaultDomain(): string;
```
getDirectory()
```php
public function getDirectory(): array|string;
```
getLocale()
```php
public function getLocale(): false|string;
```
has()
```php
public function has( string $index ): bool;
```
Check whether is defined a translation key in the internal array
nquery()
```php
public function nquery(
string $msgid1,
string $msgid2,
int $count,
array $placeholders = [],
string|null $domain = null
): string;
```
The plural version of gettext().
Some languages have more than one form for plural messages dependent on
the count.
query()
```php
public function query(
string $translateKey,
array $placeholders = []
): string;
```
Returns the translation related to the given key.
```php
$translator->query("你好 %name%！", ["name" => "Phalcon"]);
```
resetDomain()
```php
public function resetDomain(): string;
```
Sets the default domain
setDefaultDomain()
```php
public function setDefaultDomain( string $domain ): void;
```
Sets the domain default to search within when calls are made to gettext()
setDirectory()
```php
public function setDirectory( mixed $directory ): void;
```
Sets the path for a domain
```php
// Set the directory path
$gettext->setDirectory("/path/to/the/messages");
// Set the domains and directories path
$gettext->setDirectory(
[
"messages" => "/path/to/the/messages",
"another" => "/path/to/the/another",
]
);
```
setDomain()
```php
public function setDomain( string|null $domain = null ): string;
```
Changes the current domain (i.e. the translation file)
setLocale()
```php
public function setLocale(
int $category,
array $localeArray = []
): false|string;
```
Sets locale information
Note: this method has process-global side effects. Besides calling
`setlocale()`, it exports the `LC_ALL`, `LANG` and `LANGUAGE`
environment variables via `putenv()`. `LC_ALL` affects every
locale-sensitive operation in the process - `(string)` casts of floats,
`strtoupper()`/`strtolower()` tables, date formatting and more - not
just translations.
```php
// Set locale to Dutch
$gettext->setLocale(LC_ALL, ["nl_NL"]);
// Try different possible locale names for German
$gettext->setLocale(LC_ALL, ["de_DE@euro", "de_DE", "de", "ge"]);
```
getOptionsDefault()
```php
protected function getOptionsDefault(): array;
```
Gets default options
prepareOptions()
```php
protected function prepareOptions( array $options ): void;
```
Validator for constructor
## Translate\Adapter\NativeArray
Class
Defines translation lists using PHP arrays
- [`Phalcon\Translate\Adapter\AbstractAdapter`](#translateadapterabstractadapter)
- **`Phalcon\Translate\Adapter\NativeArray`**
`Phalcon\Contracts\Translate\TranslateTypes` · `Phalcon\Translate\Exception` · `Phalcon\Translate\Exceptions\InvalidDataType` · `Phalcon\Translate\Exceptions\MissingContent` · `Phalcon\Translate\InterpolatorFactory`
### Method Summary
NativeArray constructor.
Check whether is defined a translation key in the internal array
Check whether is defined a translation key in the internal array
Returns the translation related to the given key
Returns the internal array
### Methods
__construct()
```php
public function __construct(
InterpolatorFactory $interpolator,
array $options
);
```
NativeArray constructor.
exists()
```php
public function exists( string $index ): bool;
```
Check whether is defined a translation key in the internal array
has()
```php
public function has( string $index ): bool;
```
Check whether is defined a translation key in the internal array
query()
```php
public function query(
string $translateKey,
array $placeholders = []
): string;
```
Returns the translation related to the given key
toArray()
```php
public function toArray(): array;
```
Returns the internal array
## Translate\Exception
Class
Class for exceptions thrown by Phalcon\Translate
- `\Exception`
- **`Phalcon\Translate\Exception`**
- [`Phalcon\Translate\Exceptions\FileOpenError`](#translateexceptionsfileopenerror)
- [`Phalcon\Translate\Exceptions\ImmutableObject`](#translateexceptionsimmutableobject)
- [`Phalcon\Translate\Exceptions\InterpolatorNotRegistered`](#translateexceptionsinterpolatornotregistered)
- [`Phalcon\Translate\Exceptions\InvalidDataType`](#translateexceptionsinvaliddatatype)
- [`Phalcon\Translate\Exceptions\KeyNotFound`](#translateexceptionskeynotfound)
- [`Phalcon\Translate\Exceptions\MissingContent`](#translateexceptionsmissingcontent)
- [`Phalcon\Translate\Exceptions\MissingGettextExtension`](#translateexceptionsmissinggettextextension)
- [`Phalcon\Translate\Exceptions\MissingRequiredParameter`](#translateexceptionsmissingrequiredparameter)
- [`Phalcon\Translate\Exceptions\TranslatorNotRegistered`](#translateexceptionstranslatornotregistered)
## Translate\Exceptions\FileOpenError
Class
- `\Exception`
- [`Phalcon\Translate\Exception`](#translateexception)
- **`Phalcon\Translate\Exceptions\FileOpenError`**
`Phalcon\Translate\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct( string $name );
```
## Translate\Exceptions\ImmutableObject
Class
- `\Exception`
- [`Phalcon\Translate\Exception`](#translateexception)
- **`Phalcon\Translate\Exceptions\ImmutableObject`**
`Phalcon\Translate\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Translate\Exceptions\InterpolatorNotRegistered
Class
- `\Exception`
- [`Phalcon\Translate\Exception`](#translateexception)
- **`Phalcon\Translate\Exceptions\InterpolatorNotRegistered`**
`Phalcon\Translate\Exception`
## Translate\Exceptions\InvalidDataType
Class
- `\Exception`
- [`Phalcon\Translate\Exception`](#translateexception)
- **`Phalcon\Translate\Exceptions\InvalidDataType`**
`Phalcon\Translate\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Translate\Exceptions\KeyNotFound
Class
- `\Exception`
- [`Phalcon\Translate\Exception`](#translateexception)
- **`Phalcon\Translate\Exceptions\KeyNotFound`**
`Phalcon\Translate\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct( string $key );
```
## Translate\Exceptions\MissingContent
Class
- `\Exception`
- [`Phalcon\Translate\Exception`](#translateexception)
- **`Phalcon\Translate\Exceptions\MissingContent`**
`Phalcon\Translate\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Translate\Exceptions\MissingGettextExtension
Class
- `\Exception`
- [`Phalcon\Translate\Exception`](#translateexception)
- **`Phalcon\Translate\Exceptions\MissingGettextExtension`**
`Phalcon\Translate\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Translate\Exceptions\MissingRequiredParameter
Class
- `\Exception`
- [`Phalcon\Translate\Exception`](#translateexception)
- **`Phalcon\Translate\Exceptions\MissingRequiredParameter`**
`Phalcon\Translate\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct( string $parameter );
```
getParameter()
```php
public function getParameter(): string;
```
## Translate\Exceptions\TranslatorNotRegistered
Class
- `\Exception`
- [`Phalcon\Translate\Exception`](#translateexception)
- **`Phalcon\Translate\Exceptions\TranslatorNotRegistered`**
`Phalcon\Translate\Exception`
## Translate\InterpolatorFactory
Class
- [`Phalcon\Factory\AbstractConfigFactory`](/5.20/api/phalcon_factory/#factoryabstractconfigfactory)
- [`Phalcon\Factory\AbstractFactory`](/5.20/api/phalcon_factory/#factoryabstractfactory)
- **`Phalcon\Translate\InterpolatorFactory`**
`Phalcon\Factory\AbstractFactory` · `Phalcon\Translate\Exceptions\InterpolatorNotRegistered` · `Phalcon\Translate\Interpolator\AssociativeArray` · `Phalcon\Translate\Interpolator\IndexedArray` · `Phalcon\Translate\Interpolator\InterpolatorInterface` · `Throwable`
### Method Summary
Create a new instance of the adapter
Returns the available adapters
### Methods
__construct()
```php
public function __construct( array $services = [] );
```
newInstance()
```php
public function newInstance( string $name ): InterpolatorInterface;
```
Create a new instance of the adapter
getExceptionClass()
```php
protected function getExceptionClass(): string;
```
getServices()
```php
protected function getServices(): array;
```
Returns the available adapters
## Translate\Interpolator\AssociativeArray
Class
Class AssociativeArray
- **`Phalcon\Translate\Interpolator\AssociativeArray`** - implements [`Phalcon\Translate\Interpolator\InterpolatorInterface`](#translateinterpolatorinterpolatorinterface)
`Phalcon\Traits\Support\Helper\Str\InterpolateTrait`
### Method Summary
Replaces placeholders by the values passed
### Methods
replacePlaceholders()
```php
public function replacePlaceholders(
string $translation,
array $placeholders = []
): string;
```
Replaces placeholders by the values passed
## Translate\Interpolator\IndexedArray
Class
- **`Phalcon\Translate\Interpolator\IndexedArray`** - implements [`Phalcon\Translate\Interpolator\InterpolatorInterface`](#translateinterpolatorinterpolatorinterface)
### Method Summary
Replaces placeholders by the values passed
### Methods
replacePlaceholders()
```php
public function replacePlaceholders(
string $translation,
array $placeholders = []
): string;
```
Replaces placeholders by the values passed
## Translate\Interpolator\InterpolatorInterface
Interface
Phalcon\Translate\InterpolatorInterface
Interface for Phalcon\Translate interpolators
- **`Phalcon\Translate\Interpolator\InterpolatorInterface`**
### Method Summary
Replaces placeholders by the values passed
### Methods
replacePlaceholders()
```php
public function replacePlaceholders(
string $translation,
array $placeholders = []
): string;
```
Replaces placeholders by the values passed
## Translate\TranslateFactory
Class
@property InterpolatorFactory $interpolator
- [`Phalcon\Factory\AbstractConfigFactory`](/5.20/api/phalcon_factory/#factoryabstractconfigfactory)
- [`Phalcon\Factory\AbstractFactory`](/5.20/api/phalcon_factory/#factoryabstractfactory)
- **`Phalcon\Translate\TranslateFactory`**
`Phalcon\Config\ConfigInterface` · `Phalcon\Contracts\Translate\TranslateTypes` · `Phalcon\Factory\AbstractFactory` · `Phalcon\Translate\Adapter\AdapterInterface` · `Phalcon\Translate\Adapter\Csv` · `Phalcon\Translate\Adapter\Gettext` · `Phalcon\Translate\Adapter\NativeArray` · `Phalcon\Translate\Exceptions\TranslatorNotRegistered` · `Throwable`
### Method Summary
Factory to create an instance from a Config object
Create a new instance of the adapter
Returns the available adapters
### Methods
__construct()
```php
public function __construct(
InterpolatorFactory $interpolator,
array $services = []
);
```
load()
```php
public function load( mixed $config ): AdapterInterface;
```
Factory to create an instance from a Config object
newInstance()
```php
public function newInstance(
string $name,
array $options = []
): AdapterInterface;
```
Create a new instance of the adapter
getExceptionClass()
```php
protected function getExceptionClass(): string;
```
getServices()
```php
protected function getServices(): array;
```
Returns the available adapters
Source: https://docs.phalcon.io/5.20/api/phalcon_translate/index.mdx