Inheritance diagram for Zend_Translate_Adapter:

Public Member Functions
	__construct ($options=array())

	addTranslation ($options=array())

	setOptions (array $options=array())

	getOptions ($optionKey=null)

	getLocale ()

	setLocale ($locale)

	getList ()

	getMessageId ($message, $locale=null)

	getMessageIds ($locale=null)

	getMessages ($locale=null)

	isAvailable ($locale)

	translate ($messageId, $locale=null)

	plural ($singular, $plural, $number, $locale=null)

	_ ($messageId, $locale=null)

	isTranslated ($messageId, $original=false, $locale=null)

	toString ()

Static Public Member Functions
static	getCache ()

static	setCache (Zend_Cache_Core $cache)

static	hasCache ()

static	removeCache ()

static	clearCache ($tag=null)

Data Fields
const	LOCALE_DIRECTORY = 'directory'

const	LOCALE_FILENAME = 'filename'

Protected Member Functions
	_loadTranslationData ($data, $locale, array $options=array())

	_log ($message, $locale)

Protected Attributes
	$_options

	$_translate = array()

Static Protected Attributes
static	$_cache = null

Detailed Description

Definition at line 42 of file Adapter.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( $options = array() )

Generates the adapter

Parameters

string \| array \| Zend_Config	$options	Translation options for this adapter
	string\|array	[$content]
	string\|Zend_Locale	[$locale]

Exceptions

Zend_Translate_Exception

Returns: void

Definition at line 128 of file Adapter.php.

     {
         if ($options instanceof Zend_Config) {
             $options = $options->toArray();
         } else if (func_num_args() > 1) {
             $args               = func_get_args();
             $options            = array();
             $options['content'] = array_shift($args);
 
             if (!empty($args)) {
                 $options['locale'] = array_shift($args);
             }
 
             if (!empty($args)) {
                 $opt     = array_shift($args);
                 $options = array_merge($opt, $options);
             }
         } else if (!is_array($options)) {
             $options = array('content' => $options);
         }
 
         if (array_key_exists('cache', $options)) {
             self::setCache($options['cache']);
             unset($options['cache']);
         }
 
         if (isset(self::$_cache)) {
             $id = 'Zend_Translate_' . $this->toString() . '_Options';
             $result = self::$_cache->load($id);
             if ($result) {
                 $this->_options = $result;
             }
         }
 
         if (empty($options['locale']) || ($options['locale'] === "auto")) {
             $this->_automatic = true;
         } else {
             $this->_automatic = false;
         }
 
         $locale = null;
         if (!empty($options['locale'])) {
             $locale = $options['locale'];
             unset($options['locale']);
         }
 
         $this->setOptions($options);
         $options['locale'] = $locale;
 
         if (!empty($options['content'])) {
             $this->addTranslation($options);
         }
 
         if ($this->getLocale() !== (string) $options['locale']) {
             $this->setLocale($options['locale']);
         }
     }

Member Function Documentation

◆ _()

_	(	$messageId,
		$locale = `null`
	)

Translates the given string returns the translation

Parameters

string	$messageId	Translation string
string \| Zend_Locale	$locale	(optional) Locale/Language to use, identical with locale identifier,

See also: Zend_Locale for more information

Returns: string

Definition at line 853 of file Adapter.php.

     {
         return $this->translate($messageId, $locale);
     }

◆ _loadTranslationData()

_loadTranslationData	(		$data,
			$locale,
		array	$options = `array()`
	)

abstractprotected

Load translation data

Parameters

mixed	$data
string \| Zend_Locale	$locale
array	$options	(optional)

Returns: array

◆ _log()

_log	(	$message,
		$locale
	)

protected

Logs a message when the log option is set

Parameters

string	$message	Message to log
String	$locale	Locale to log

Definition at line 832 of file Adapter.php.

                                                {
         if ($this->_options['logUntranslated']) {
             $message = str_replace('%message%', $message, $this->_options['logMessage']);
             $message = str_replace('%locale%', $locale, $message);
             if ($this->_options['log']) {
                 $this->_options['log']->log($message, $this->_options['logPriority']);
             } else {
                 trigger_error($message, E_USER_NOTICE);
             }
         }
     }

◆ addTranslation()

addTranslation ( $options = array() )

Add translations

This may be a new language or additional content for an existing language If the key 'clear' is true, then translations for the specified language will be replaced and added otherwise

Parameters

array | Zend_Config $options Options and translations to be added

Exceptions

Zend_Translate_Exception

Returns: Zend_Translate_Adapter Provides fluent interface

Definition at line 197 of file Adapter.php.

     {
         if ($options instanceof Zend_Config) {
             $options = $options->toArray();
         } else if (func_num_args() > 1) {
             $args = func_get_args();
             $options            = array();
             $options['content'] = array_shift($args);
 
             if (!empty($args)) {
                 $options['locale'] = array_shift($args);
             }
 
             if (!empty($args)) {
                 $opt     = array_shift($args);
                 $options = array_merge($opt, $options);
             }
         } else if (!is_array($options)) {
             $options = array('content' => $options);
         }
 
         if (!isset($options['content']) || empty($options['content'])) {
             #require_once 'Zend/Translate/Exception.php';
             throw new Zend_Translate_Exception("Required option 'content' is missing");
         }
 
         $originate = null;
         if (!empty($options['locale'])) {
             $originate = (string) $options['locale'];
         }
 
         if ((array_key_exists('log', $options)) && !($options['log'] instanceof Zend_Log)) {
             #require_once 'Zend/Translate/Exception.php';
             throw new Zend_Translate_Exception('Instance of Zend_Log expected for option log');
         }
 
         try {
             if (!($options['content'] instanceof Zend_Translate) && !($options['content'] instanceof Zend_Translate_Adapter)) {
                 if (empty($options['locale'])) {
                     $options['locale'] = null;
                 }
 
                 $options['locale'] = Zend_Locale::findLocale($options['locale']);
             }
         } catch (Zend_Locale_Exception $e) {
             #require_once 'Zend/Translate/Exception.php';
             throw new Zend_Translate_Exception("The given Language '{$options['locale']}' does not exist", 0, $e);
         }
 
         $options  = $options + $this->_options;
         if (is_string($options['content']) and is_dir($options['content'])) {
             $options['content'] = realpath($options['content']);
             $prev = '';
             $iterator = new RecursiveIteratorIterator(
                 new RecursiveRegexIterator(
                     new RecursiveDirectoryIterator($options['content'], RecursiveDirectoryIterator::KEY_AS_PATHNAME),
                     '/^(?!.*(\.svn|\.cvs)).*$/', RecursiveRegexIterator::MATCH
                 ),
                 RecursiveIteratorIterator::SELF_FIRST
             );
 
             foreach ($iterator as $directory => $info) {
                 $file = $info->getFilename();
                 if (is_array($options['ignore'])) {
                     foreach ($options['ignore'] as $key => $ignore) {
                         if (strpos($key, 'regex') !== false) {
                             if (preg_match($ignore, $directory)) {
                                 // ignore files matching the given regex from option 'ignore' and all files below
                                 continue 2;
                             }
                         } else if (strpos($directory, DIRECTORY_SEPARATOR . $ignore) !== false) {
                             // ignore files matching first characters from option 'ignore' and all files below
                             continue 2;
                         }
                     }
                 } else {
                     if (strpos($directory, DIRECTORY_SEPARATOR . $options['ignore']) !== false) {
                         // ignore files matching first characters from option 'ignore' and all files below
                         continue;
                     }
                 }
 
                 if ($info->isDir()) {
                     // pathname as locale
                     if (($options['scan'] === self::LOCALE_DIRECTORY) and (Zend_Locale::isLocale($file, true, false))) {
                         $options['locale'] = $file;
                         $prev              = (string) $options['locale'];
                     }
                 } else if ($info->isFile()) {
                     // filename as locale
                     if ($options['scan'] === self::LOCALE_FILENAME) {
                         $filename = explode('.', $file);
                         array_pop($filename);
                         $filename = implode('.', $filename);
                         if (Zend_Locale::isLocale((string) $filename, true, false)) {
                             $options['locale'] = (string) $filename;
                         } else {
                             $parts  = explode('.', $file);
                             $parts2 = array();
                             foreach($parts as $token) {
                                 $parts2 += explode('_', $token);
                             }
                             $parts  = array_merge($parts, $parts2);
                             $parts2 = array();
                             foreach($parts as $token) {
                                 $parts2 += explode('-', $token);
                             }
                             $parts = array_merge($parts, $parts2);
                             $parts = array_unique($parts);
                             $prev  = '';
                             foreach($parts as $token) {
                                 if (Zend_Locale::isLocale($token, true, false)) {
                                     if (strlen($prev) <= strlen($token)) {
                                         $options['locale'] = $token;
                                         $prev              = $token;
                                     }
                                 }
                             }
                         }
                     }
 
                     try {
                         $options['content'] = $info->getPathname();
                         $this->_addTranslationData($options);
                     } catch (Zend_Translate_Exception $e) {
                         // ignore failed sources while scanning
                     }
                 }
             }
 
             unset($iterator);
         } else {
             $this->_addTranslationData($options);
         }
 
         if ((isset($this->_translate[$originate]) === true) and (count($this->_translate[$originate]) > 0)) {
             $this->setLocale($originate);
         }
 
         return $this;
     }

◆ clearCache()

static clearCache ( $tag = null )

static

Clears all set cache data

Parameters

string $tag Tag to clear when the default tag name is not used

Returns: void

Definition at line 959 of file Adapter.php.

     {
         #require_once 'Zend/Cache.php';
         if (self::$_cacheTags) {
             if ($tag == null) {
                 $tag = 'Zend_Translate';
             }
 
             self::$_cache->clean(Zend_Cache::CLEANING_MODE_MATCHING_TAG, array($tag));
         } else {
             self::$_cache->clean(Zend_Cache::CLEANING_MODE_ALL);
         }
     }

◆ getCache()

static getCache ( )

static

Returns the set cache

Returns: Zend_Cache_Core The set cache

Definition at line 913 of file Adapter.php.

     {
         return self::$_cache;
     }

◆ getList()

getList ( )

Returns the available languages from this adapter

Returns: array|null

Definition at line 484 of file Adapter.php.

     {
         $list = array_keys($this->_translate);
         $result = null;
         foreach($list as $value) {
             if (!empty($this->_translate[$value])) {
                 $result[$value] = $value;
             }
         }
         return $result;
     }

◆ getLocale()

getLocale ( )

Gets locale

Returns: Zend_Locale|string|null

Definition at line 411 of file Adapter.php.

     {
         return $this->_options['locale'];
     }

◆ getMessageId()

getMessageId	(	$message,
		$locale = `null`
	)

Returns the message id for a given translation If no locale is given, the actual language will be used

Parameters

string	$message	Message to get the key for
string \| Zend_Locale	$locale	(optional) Language to return the message ids from

Returns: string|array|false

Definition at line 504 of file Adapter.php.

     {
         if (empty($locale) or !$this->isAvailable($locale)) {
             $locale = $this->_options['locale'];
         }
 
         return array_search($message, $this->_translate[(string) $locale]);
     }

◆ getMessageIds()

getMessageIds ( $locale = null )

Returns all available message ids from this adapter If no locale is given, the actual language will be used

Parameters

string | Zend_Locale $locale (optional) Language to return the message ids from

Returns: array

Definition at line 520 of file Adapter.php.

     {
         if (empty($locale) or !$this->isAvailable($locale)) {
             $locale = $this->_options['locale'];
         }
 
         return array_keys($this->_translate[(string) $locale]);
     }

◆ getMessages()

getMessages ( $locale = null )

Returns all available translations from this adapter If no locale is given, the actual language will be used If 'all' is given the complete translation dictionary will be returned

Parameters

string | Zend_Locale $locale (optional) Language to return the messages from

Returns: array

Definition at line 537 of file Adapter.php.

     {
         if ($locale === 'all') {
             return $this->_translate;
         }
 
         if ((empty($locale) === true) or ($this->isAvailable($locale) === false)) {
             $locale = $this->_options['locale'];
         }
 
         return $this->_translate[(string) $locale];
     }

◆ getOptions()

getOptions ( $optionKey = null )

Returns the adapters name and it's options

Parameters

string | null $optionKey String returns this option null returns all options

Returns: integer|string|array|null

Definition at line 393 of file Adapter.php.

     {
         if ($optionKey === null) {
             return $this->_options;
         }
 
         if (isset($this->_options[$optionKey]) === true) {
             return $this->_options[$optionKey];
         }
 
         return null;
     }

◆ hasCache()

static hasCache ( )

static

Returns true when a cache is set

Returns: boolean

Definition at line 934 of file Adapter.php.

     {
         if (self::$_cache !== null) {
             return true;
         }
 
         return false;
     }

◆ isAvailable()

isAvailable ( $locale )

Is the wished language available ?

See also: Zend_Locale

Parameters

string | Zend_Locale $locale Language to search for, identical with locale identifier,

See also: Zend_Locale for more information

Returns: boolean

Definition at line 558 of file Adapter.php.

     {
         $return = isset($this->_translate[(string) $locale]);
         return $return;
     }

◆ isTranslated()

isTranslated	(	$messageId,
		$original = `false`,
		$locale = `null`
	)

Checks if a string is translated within the source or not returns boolean

Parameters

string	$messageId	Translation string
boolean	$original	(optional) Allow translation only for original language when true, a translation for 'en_US' would give false when it can be translated with 'en' only
string \| Zend_Locale	$locale	(optional) Locale/Language to use, identical with locale identifier, see Zend_Locale for more information

Returns: boolean

Definition at line 870 of file Adapter.php.

     {
         if (($original !== false) and ($original !== true)) {
             $locale   = $original;
             $original = false;
         }
 
         if ($locale === null) {
             $locale = $this->_options['locale'];
         }
 
         if (!Zend_Locale::isLocale($locale, true, false)) {
             if (!Zend_Locale::isLocale($locale, false, false)) {
                 // language does not exist, return original string
                 return false;
             }
 
             $locale = new Zend_Locale($locale);
         }
 
         $locale = (string) $locale;
         if ((is_string($messageId) || is_int($messageId)) && isset($this->_translate[$locale][$messageId])) {
             // return original translation
             return true;
         } else if ((strlen($locale) != 2) and ($original === false)) {
             // faster than creating a new locale and separate the leading part
             $locale = substr($locale, 0, -strlen(strrchr($locale, '_')));
 
             if ((is_string($messageId) || is_int($messageId)) && isset($this->_translate[$locale][$messageId])) {
                 // return regionless translation (en_US -> en)
                 return true;
             }
         }
 
         // No translation found, return original
         return false;
     }

◆ plural()

plural	(	$singular,
		$plural,
		$number,
		$locale = `null`
	)

Translates the given string using plural notations Returns the translated string

See also: Zend_Locale

Parameters

string	$singular	Singular translation string
string	$plural	Plural translation string
integer	$number	Number for detecting the correct plural
string \| Zend_Locale	$locale	(Optional) Locale/Language to use, identical with locale identifier,

See also: Zend_Locale for more information

Returns: string

Definition at line 821 of file Adapter.php.

     {
         return $this->translate(array($singular, $plural, $number), $locale);
     }

◆ removeCache()

static removeCache ( )

static

Removes any set cache

Returns: void

Definition at line 948 of file Adapter.php.

     {
         self::$_cache = null;
     }

◆ setCache()

static setCache ( Zend_Cache_Core $cache )

static

Sets a cache for all Zend_Translate_Adapters

Parameters

Zend_Cache_Core $cache Cache to store to

Definition at line 923 of file Adapter.php.

     {
         self::$_cache = $cache;
         self::_getTagSupportForCache();
     }

◆ setLocale()

setLocale ( $locale )

Sets locale

Parameters

string | Zend_Locale $locale Locale to set

Exceptions

Zend_Translate_Exception

Returns: Zend_Translate_Adapter Provides fluent interface

Definition at line 423 of file Adapter.php.

     {
         if (($locale === "auto") or ($locale === null)) {
             $this->_automatic = true;
         } else {
             $this->_automatic = false;
         }
 
         try {
             $locale = Zend_Locale::findLocale($locale);
         } catch (Zend_Locale_Exception $e) {
             #require_once 'Zend/Translate/Exception.php';
             throw new Zend_Translate_Exception("The given Language ({$locale}) does not exist", 0, $e);
         }
 
         if (!isset($this->_translate[$locale])) {
             $temp = explode('_', $locale);
             if (!isset($this->_translate[$temp[0]]) and !isset($this->_translate[$locale])) {
                 if (!$this->_options['disableNotices']) {
                     if ($this->_options['log']) {
                         $this->_options['log']->log("The language '{$locale}' has to be added before it can be used.", $this->_options['logPriority']);
                     } else {
                         trigger_error("The language '{$locale}' has to be added before it can be used.", E_USER_NOTICE);
                     }
                 }
             }
 
             $locale = $temp[0];
         }
 
         if (empty($this->_translate[$locale])) {
             if (!$this->_options['disableNotices']) {
                 if ($this->_options['log']) {
                     $this->_options['log']->log("No translation for the language '{$locale}' available.", $this->_options['logPriority']);
                 } else {
                     trigger_error("No translation for the language '{$locale}' available.", E_USER_NOTICE);
                 }
             }
         }
 
         if ($this->_options['locale'] != $locale) {
             $this->_options['locale'] = $locale;
 
             if (isset(self::$_cache)) {
                 $id = 'Zend_Translate_' . $this->toString() . '_Options';
                 if (self::$_cacheTags) {
                     self::$_cache->save($this->_options, $id, array($this->_options['tag']));
                 } else {
                     self::$_cache->save($this->_options, $id);
                 }
             }
         }
 
         return $this;
     }

◆ setOptions()

setOptions ( array $options = array() )

Sets new adapter options

Parameters

array $options Adapter options

Exceptions

Zend_Translate_Exception

Returns: Zend_Translate_Adapter Provides fluent interface

Definition at line 346 of file Adapter.php.

     {
         $change = false;
         $locale = null;
         foreach ($options as $key => $option) {
             if ($key == 'locale') {
                 $locale = $option;
             } else if ((isset($this->_options[$key]) and ($this->_options[$key] != $option)) or
                     !isset($this->_options[$key])) {
                 if (($key == 'log') && !($option instanceof Zend_Log)) {
                     #require_once 'Zend/Translate/Exception.php';
                     throw new Zend_Translate_Exception('Instance of Zend_Log expected for option log');
                 }
 
                 if ($key == 'cache') {
                     self::setCache($option);
                     continue;
                 }
 
                 $this->_options[$key] = $option;
                 $change = true;
             }
         }
 
         if ($locale !== null) {
             $this->setLocale($locale);
         }
 
         if (isset(self::$_cache) and ($change == true)) {
             $id = 'Zend_Translate_' . $this->toString() . '_Options';
             if (self::$_cacheTags) {
                 self::$_cache->save($this->_options, $id, array($this->_options['tag']));
             } else {
                 self::$_cache->save($this->_options, $id);
             }
         }
 
         return $this;
     }

◆ toString()

toString ( )

abstract

Returns the adapter name

Returns: string

◆ translate()

translate	(	$messageId,
		$locale = `null`
	)

Translates the given string returns the translation

See also: Zend_Locale

Parameters

string \| array	$messageId	Translation string, or Array for plural translations
string \| Zend_Locale	$locale	(optional) Locale/Language to use, identical with locale identifier,

See also: Zend_Locale for more information

Returns: string

Definition at line 701 of file Adapter.php.

     {
         if ($locale === null) {
             $locale = $this->_options['locale'];
         }
 
         $plural = null;
         if (is_array($messageId)) {
             if (count($messageId) > 2) {
                 $number = array_pop($messageId);
                 if (!is_numeric($number)) {
                     $plocale = $number;
                     $number  = array_pop($messageId);
                 } else {
                     $plocale = 'en';
                 }
 
                 $plural    = $messageId;
                 $messageId = $messageId[0];
             } else {
                 $messageId = $messageId[0];
             }
         }
 
         if (!Zend_Locale::isLocale($locale, true, false)) {
             if (!Zend_Locale::isLocale($locale, false, false)) {
                 // language does not exist, return original string
                 $this->_log($messageId, $locale);
                 // use rerouting when enabled
                 if (!empty($this->_options['route'])) {
                     if (array_key_exists($locale, $this->_options['route']) &&
                         !array_key_exists($locale, $this->_routed)) {
                         $this->_routed[$locale] = true;
                         return $this->translate($messageId, $this->_options['route'][$locale]);
                     }
                 }
 
                 $this->_routed = array();
                 if ($plural === null) {
                     return $messageId;
                 }
 
                 $rule = Zend_Translate_Plural::getPlural($number, $plocale);
                 if (!isset($plural[$rule])) {
                     $rule = 0;
                 }
 
                 return $plural[$rule];
             }
 
             $locale = new Zend_Locale($locale);
         }
 
         $locale = (string) $locale;
         if ((is_string($messageId) || is_int($messageId)) && isset($this->_translate[$locale][$messageId])) {
             // return original translation
             if ($plural === null) {
                 $this->_routed = array();
                 return $this->_translate[$locale][$messageId];
             }
 
             $rule = Zend_Translate_Plural::getPlural($number, $locale);
             if (isset($this->_translate[$locale][$plural[0]][$rule])) {
                 $this->_routed = array();
                 return $this->_translate[$locale][$plural[0]][$rule];
             }
         } else if (strlen($locale) != 2) {
             // faster than creating a new locale and separate the leading part
             $locale = substr($locale, 0, -strlen(strrchr($locale, '_')));
 
             if ((is_string($messageId) || is_int($messageId)) && isset($this->_translate[$locale][$messageId])) {
                 // return regionless translation (en_US -> en)
                 if ($plural === null) {
                     $this->_routed = array();
                     return $this->_translate[$locale][$messageId];
                 }
 
                 $rule = Zend_Translate_Plural::getPlural($number, $locale);
                 if (isset($this->_translate[$locale][$plural[0]][$rule])) {
                     $this->_routed = array();
                     return $this->_translate[$locale][$plural[0]][$rule];
                 }
             }
         }
 
         $this->_log($messageId, $locale);
         // use rerouting when enabled
         if (!empty($this->_options['route'])) {
             if (array_key_exists($locale, $this->_options['route']) &&
                 !array_key_exists($locale, $this->_routed)) {
                 $this->_routed[$locale] = true;
                 return $this->translate($messageId, $this->_options['route'][$locale]);
             }
         }
 
         $this->_routed = array();
         if ($plural === null) {
             return $messageId;
         }
 
         $rule = Zend_Translate_Plural::getPlural($number, $plocale);
         if (!isset($plural[$rule])) {
             $rule = 0;
         }
 
         return $plural[$rule];
     }

Field Documentation

◆ $_cache

$_cache = null

staticprotected

Definition at line 59 of file Adapter.php.

◆ $_options

$_options

protected

Initial value:

= array(
        'clear'           => false,
        'content'         => null,
        'disableNotices'  => false,
        'ignore'          => '.',
        'locale'          => 'auto',
        'log'             => null,
        'logMessage'      => "Untranslated message within '%locale%': %message%",
        'logPriority'     => 5,
        'logUntranslated' => false,
        'reload'          => false,
        'route'           => null,
        'scan'            => null,
        'tag'             => 'Zend_Translate'
    )

Definition at line 97 of file Adapter.php.

◆ $_translate

$_translate = array()

protected

Definition at line 117 of file Adapter.php.

◆ LOCALE_DIRECTORY

const LOCALE_DIRECTORY = 'directory'

Scans for the locale within the name of the directory @constant integer

Definition at line 72 of file Adapter.php.

◆ LOCALE_FILENAME

const LOCALE_FILENAME = 'filename'

Scans for the locale within the name of the file @constant integer

Definition at line 78 of file Adapter.php.

The documentation for this class was generated from the following file:

vendor/magento/zendframework1/library/Zend/Translate/Adapter.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _()

◆ _loadTranslationData()

◆ _log()

◆ addTranslation()

◆ clearCache()

◆ getCache()

◆ getList()

◆ getLocale()

◆ getMessageId()

◆ getMessageIds()

◆ getMessages()

◆ getOptions()

◆ hasCache()

◆ isAvailable()

◆ isTranslated()

◆ plural()

◆ removeCache()

◆ setCache()

◆ setLocale()

◆ setOptions()

◆ toString()

◆ translate()

Field Documentation

◆ $_cache

◆ $_options

◆ $_translate

◆ LOCALE_DIRECTORY

◆ LOCALE_FILENAME