Skip to content

Phalcon translate

NOTE

All classes are prefixed with Phalcon

Translate\Adapter\AbstractAdapter

Abstract Source on GitHub

@template TKey of string @template TValue of string @implements ArrayAccess

Uses ArrayAccess · Phalcon\Translate\Exception · Phalcon\Translate\Exceptions\ImmutableObject · Phalcon\Translate\Exceptions\KeyNotFound · Phalcon\Translate\InterpolatorFactory · Phalcon\Translate\Interpolator\InterpolatorInterface

Method Summary

public __construct(InterpolatorFactory $interpolator,array $options = []) AbstractAdapter constructor. public string _(string $translateKey,array $placeholders = []) Returns the translation string of the given key (alias of method 't') public string notFound( string $index ) Whenever a key is not found this method will be called public bool offsetExists( mixed $translateKey ) Check whether a translation key exists public string|null offsetGet( mixed $translateKey ) Returns the translation related to the given key public void offsetSet(mixed $offset,mixed $value) Sets a translation value public void offsetUnset( mixed $offset ) Unsets a translation from the dictionary public string t(string $translateKey,array $placeholders = []) Returns the translation string of the given key protected string replacePlaceholders(string $translation,array $placeholders = []) Replaces placeholders by the values passed

Properties

protected string $defaultInterpolator = ""
protected InterpolatorInterface | null $interpolator = null
protected InterpolatorFactory $interpolatorFactory
protected bool $triggerError = false

Methods

Public · 8

__construct()

public function __construct(
    InterpolatorFactory $interpolator,
    array $options = []
);

AbstractAdapter constructor.

_()

public function _(
    string $translateKey,
    array $placeholders = []
): string;

Returns the translation string of the given key (alias of method 't')

notFound()

public function notFound( string $index ): string;

Whenever a key is not found this method will be called

offsetExists()

public function offsetExists( mixed $translateKey ): bool;

Check whether a translation key exists

offsetGet()

public function offsetGet( mixed $translateKey ): string|null;

Returns the translation related to the given key

offsetSet()

public function offsetSet(
    mixed $offset,
    mixed $value
): void;

Sets a translation value

offsetUnset()

public function offsetUnset( mixed $offset ): void;

Unsets a translation from the dictionary

t()

public function t(
    string $translateKey,
    array $placeholders = []
): string;

Returns the translation string of the given key

Protected · 1

replacePlaceholders()

protected function replacePlaceholders(
    string $translation,
    array $placeholders = []
): string;

Replaces placeholders by the values passed

Translate\Adapter\AdapterInterface

Interface Source on GitHub

Phalcon\Translate\Adapter\AdapterInterface

Interface for Phalcon\Translate adapters

  • Phalcon\Translate\Adapter\AdapterInterface

Method Summary

public bool has( string $index ) Check whether is defined a translation key in the internal array public string query(string $translateKey,array $placeholders = []) Returns the translation related to the given key public string t(string $translateKey,array $placeholders = []) Returns the translation string of the given key

Methods

Public · 3

has()

public function has( string $index ): bool;

Check whether is defined a translation key in the internal array

query()

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()

public function t(
    string $translateKey,
    array $placeholders = []
): string;

Returns the translation string of the given key

Translate\Adapter\Csv

Class Source on GitHub

Uses Phalcon\Translate\Exception · Phalcon\Translate\Exceptions\FileOpenError · Phalcon\Translate\Exceptions\MissingRequiredParameter · Phalcon\Translate\InterpolatorFactory

Method Summary

public __construct(InterpolatorFactory $interpolator,array $options) Csv constructor. public bool exists( string $index ) Check whether is defined a translation key in the internal array public bool has( string $index ) Check whether is defined a translation key in the internal array public string query(string $translateKey,array $placeholders = []) Returns the translation related to the given key public array toArray() Returns the internal array protected phpFopen(string $filename,string $mode) @todo to be removed when we get traits

Properties

protected array $translate = []

Methods

Public · 5

__construct()

public function __construct(
    InterpolatorFactory $interpolator,
    array $options
);

Csv constructor.

exists()

public function exists( string $index ): bool;

Check whether is defined a translation key in the internal array

has()

public function has( string $index ): bool;

Check whether is defined a translation key in the internal array

query()

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

Returns the translation related to the given key

toArray()

public function toArray(): array;

Returns the internal array

Protected · 1

phpFopen()

protected function phpFopen(
    string $filename,
    string $mode
);

@todo to be removed when we get traits

Translate\Adapter\Gettext

Class Source on GitHub

Phalcon\Translate\Adapter\Gettext

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

Uses Phalcon\Translate\Exception · Phalcon\Translate\Exceptions\MissingGettextExtension · Phalcon\Translate\Exceptions\MissingRequiredParameter · Phalcon\Translate\InterpolatorFactory

Method Summary

public __construct(InterpolatorFactory $interpolator,array $options) Gettext constructor. public bool exists( string $index ) Check whether is defined a translation key in the internal array public int getCategory() public string getDefaultDomain() public array|string getDirectory() public string|false getLocale() public bool has( string $index ) Check whether is defined a translation key in the internal array public string nquery(string $msgid1,string $msgid2,int $count,array $placeholders = [],string $domain = null) The plural version of gettext(). public string query(string $translateKey,array $placeholders = []) Returns the translation related to the given key. public string resetDomain() Sets the default domain public void setDefaultDomain( string $domain ) Sets the domain default to search within when calls are made to gettext() public void setDirectory( mixed $directory ) Sets the path for a domain public string setDomain( string $domain = null ) Changes the current domain (i.e. the translation file) public string|bool setLocale(int $category,array $localeArray = []) Sets locale information protected array getOptionsDefault() Gets default options protected bool phpFunctionExists( string $name ) @todo to be removed when we get traits protected void prepareOptions( array $options ) Validator for constructor

Properties

protected int $category
protected string $defaultDomain
protected string|array $directory
protected string | false $locale

Methods

Public · 14

__construct()

public function __construct(
    InterpolatorFactory $interpolator,
    array $options
);

Gettext constructor.

exists()

public function exists( string $index ): bool;

Check whether is defined a translation key in the internal array

getCategory()

public function getCategory(): int;

getDefaultDomain()

public function getDefaultDomain(): string;

getDirectory()

public function getDirectory(): array|string;

getLocale()

public function getLocale(): string|false;

has()

public function has( string $index ): bool;

Check whether is defined a translation key in the internal array

nquery()

public function nquery(
    string $msgid1,
    string $msgid2,
    int $count,
    array $placeholders = [],
    string $domain = null
): string;

The plural version of gettext(). Some languages have more than one form for plural messages dependent on the count.

query()

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

Returns the translation related to the given key.

$translator->query("你好 %name%！", ["name" => "Phalcon"]);

resetDomain()

public function resetDomain(): string;

Sets the default domain

setDefaultDomain()

public function setDefaultDomain( string $domain ): void;

Sets the domain default to search within when calls are made to gettext()

setDirectory()

public function setDirectory( mixed $directory ): void;

Sets the path for a domain

// 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()

public function setDomain( string $domain = null ): string;

Changes the current domain (i.e. the translation file)

setLocale()

public function setLocale(
    int $category,
    array $localeArray = []
): string|bool;

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.

// 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"]);
Protected · 3

getOptionsDefault()

protected function getOptionsDefault(): array;

Gets default options

phpFunctionExists()

protected function phpFunctionExists( string $name ): bool;

@todo to be removed when we get traits

prepareOptions()

protected function prepareOptions( array $options ): void;

Validator for constructor

Translate\Adapter\NativeArray

Class Source on GitHub

Defines translation lists using PHP arrays

Uses Phalcon\Translate\Exception · Phalcon\Translate\Exceptions\InvalidDataType · Phalcon\Translate\Exceptions\MissingContent · Phalcon\Translate\InterpolatorFactory

Method Summary

public __construct(InterpolatorFactory $interpolator,array $options) NativeArray constructor. public bool exists( string $index ) Check whether is defined a translation key in the internal array public bool has( string $index ) Check whether is defined a translation key in the internal array public string query(string $translateKey,array $placeholders = []) Returns the translation related to the given key public array toArray() Returns the internal array

Methods

Public · 5

__construct()

public function __construct(
    InterpolatorFactory $interpolator,
    array $options
);

NativeArray constructor.

exists()

public function exists( string $index ): bool;

Check whether is defined a translation key in the internal array

has()

public function has( string $index ): bool;

Check whether is defined a translation key in the internal array

query()

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

Returns the translation related to the given key

toArray()

public function toArray(): array;

Returns the internal array

Translate\Exception

Class Source on GitHub

Class for exceptions thrown by Phalcon\Translate

Translate\Exceptions\FileOpenError

Class Source on GitHub

Uses Phalcon\Translate\Exception

Method Summary

public __construct( string $name )

Methods

Public · 1

__construct()

public function __construct( string $name );

Translate\Exceptions\ImmutableObject

Class Source on GitHub

Uses Phalcon\Translate\Exception

Method Summary

public __construct()

Methods

Public · 1

__construct()

public function __construct();

Translate\Exceptions\InterpolatorNotRegistered

Class Source on GitHub

Uses Phalcon\Translate\Exception

Translate\Exceptions\InvalidDataType

Class Source on GitHub

Uses Phalcon\Translate\Exception

Method Summary

public __construct()

Methods

Public · 1

__construct()

public function __construct();

Translate\Exceptions\KeyNotFound

Class Source on GitHub

Uses Phalcon\Translate\Exception

Method Summary

public __construct( string $key )

Methods

Public · 1

__construct()

public function __construct( string $key );

Translate\Exceptions\MissingContent

Class Source on GitHub

Uses Phalcon\Translate\Exception

Method Summary

public __construct()

Methods

Public · 1

__construct()

public function __construct();

Translate\Exceptions\MissingGettextExtension

Class Source on GitHub

Uses Phalcon\Translate\Exception

Method Summary

public __construct()

Methods

Public · 1

__construct()

public function __construct();

Translate\Exceptions\MissingRequiredParameter

Class Source on GitHub

Uses Phalcon\Translate\Exception

Method Summary

public __construct( string $parameter ) public string getParameter()

Methods

Public · 2

__construct()

public function __construct( string $parameter );

getParameter()

public function getParameter(): string;

Translate\Exceptions\TranslatorNotRegistered

Class Source on GitHub

Uses Phalcon\Translate\Exception

Translate\InterpolatorFactory

Class Source on GitHub

Uses Phalcon\Factory\AbstractFactory · Phalcon\Translate\Interpolator\InterpolatorInterface

Method Summary

public __construct( array $services = [] ) public InterpolatorInterface newInstance( string $name ) Create a new instance of the adapter protected string getExceptionClass() protected array getServices() Returns the available adapters

Methods

Public · 2

__construct()

public function __construct( array $services = [] );

newInstance()

public function newInstance( string $name ): InterpolatorInterface;

Create a new instance of the adapter

Protected · 2

getExceptionClass()

protected function getExceptionClass(): string;

getServices()

protected function getServices(): array;

Returns the available adapters

Translate\Interpolator\AssociativeArray

Class Source on GitHub

Class AssociativeArray

Uses Phalcon\Support\Helper\Str\Interpolate

Method Summary

public string replacePlaceholders(string $translation,array $placeholders = []) Replaces placeholders by the values passed

Properties

protected Interpolate | null $interpolate = null

Methods

Public · 1

replacePlaceholders()

public function replacePlaceholders(
    string $translation,
    array $placeholders = []
): string;

Replaces placeholders by the values passed

Translate\Interpolator\IndexedArray

Class Source on GitHub

Method Summary

public string replacePlaceholders(string $translation,array $placeholders = []) Replaces placeholders by the values passed

Methods

Public · 1

replacePlaceholders()

public function replacePlaceholders(
    string $translation,
    array $placeholders = []
): string;

Replaces placeholders by the values passed

Translate\Interpolator\InterpolatorInterface

Interface Source on GitHub

Phalcon\Translate\InterpolatorInterface

Interface for Phalcon\Translate interpolators

  • Phalcon\Translate\Interpolator\InterpolatorInterface

Method Summary

public string replacePlaceholders(string $translation,array $placeholders = []) Replaces placeholders by the values passed

Methods

Public · 1

replacePlaceholders()

public function replacePlaceholders(
    string $translation,
    array $placeholders = []
): string;

Replaces placeholders by the values passed

Translate\TranslateFactory

Class Source on GitHub

@property InterpolatorFactory $interpolator

Uses Phalcon\Config\ConfigInterface · Phalcon\Factory\AbstractFactory · Phalcon\Translate\Adapter\AdapterInterface

Method Summary

public __construct(InterpolatorFactory $interpolator,array $services = []) public AdapterInterface load( mixed $config ) Factory to create an instance from a Config object public AdapterInterface newInstance(string $name,array $options = []) Create a new instance of the adapter protected string getExceptionClass() protected array getServices() Returns the available adapters

Methods

Public · 3

__construct()

public function __construct(
    InterpolatorFactory $interpolator,
    array $services = []
);

load()

public function load( mixed $config ): AdapterInterface;

Factory to create an instance from a Config object

newInstance()

public function newInstance(
    string $name,
    array $options = []
): AdapterInterface;

Create a new instance of the adapter

Protected · 2

getExceptionClass()

protected function getExceptionClass(): string;

getServices()

protected function getServices(): array;

Returns the available adapters