Zend_Translate_Adapter_Tmx Class Reference

Inheritance diagram for Zend_Translate_Adapter_Tmx:

Public Member Functions
	toString ()
Public Member Functions inherited from Zend_Translate_Adapter
	__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 ()

Protected Member Functions
	_loadTranslationData ($filename, $locale, array $options=array())
	_startElement ($file, $name, $attrib)
	_endElement ($file, $name)
	_contentElement ($file, $data)
	_findEncoding ($filename)
Protected Member Functions inherited from Zend_Translate_Adapter
	_loadTranslationData ($data, $locale, array $options=array())
	_log ($message, $locale)

Additional Inherited Members
Static Public Member Functions inherited from Zend_Translate_Adapter
static	getCache ()
static	setCache (Zend_Cache_Core $cache)
static	hasCache ()
static	removeCache ()
static	clearCache ($tag=null)
Data Fields inherited from Zend_Translate_Adapter
const	LOCALE_DIRECTORY = 'directory'
const	LOCALE_FILENAME = 'filename'
Protected Attributes inherited from Zend_Translate_Adapter
	$_options
	$_translate = array()
Static Protected Attributes inherited from Zend_Translate_Adapter
static	$_cache = null

Detailed Description

Definition at line 41 of file Tmx.php.

Member Function Documentation

_contentElement()

_contentElement (   $file,   $data  )

protected

Internal method, called by xml element handler for content

Parameters

resource	$file	File handler
string	$data	Elements content

Definition at line 214 of file Tmx.php.

    {
        if (($this->_seg !== null) and ($this->_tu !== null) and ($this->_tuv !== null)) {
            $this->_content .= $data;
        }
    }

_endElement()

_endElement (   $file,   $name  )

protected

Internal method, called by xml element handler at end

Parameters

resource	$file	File handler
string	$name	Elements name

Definition at line 180 of file Tmx.php.

    {
        if (($this->_seg !== null) and ($name !== 'seg')) {
            $this->_content .= "</".$name.">";
        } else {
            switch (strtolower($name)) {
                case 'tu':
                    $this->_tu = null;
                    break;
                case 'tuv':
                    $this->_tuv = null;
                    break;
                case 'seg':
                    $this->_seg = null;
                    if (!empty($this->_srclang) && ($this->_srclang == $this->_tuv)) {
                        $this->_tu = $this->_content;
                    }

                    if (!empty($this->_content) or (!isset($this->_data[$this->_tuv][$this->_tu]))) {
                        $this->_data[$this->_tuv][$this->_tu] = $this->_content;
                    }
                    break;
                default:
                    break;
            }
        }
    }

_findEncoding()

_findEncoding (   $filename )

protected

Internal method, detects the encoding of the xml file

Parameters

string

$name

Filename

Returns

string Encoding

Definition at line 228 of file Tmx.php.

    {
        $file = file_get_contents($filename, null, null, 0, 100);
        if (strpos($file, "encoding") !== false) {
            $encoding = substr($file, strpos($file, "encoding") + 9);
            $encoding = substr($encoding, 1, strpos($encoding, $encoding[0], 1) - 1);
            return $encoding;
        }
        return 'UTF-8';
    }

_loadTranslationData()

_loadTranslationData (   $filename,   $locale, array  $options = array()  )

protected

Load translation data (TMX file reader)

Parameters

string	$filename	TMX file to add, full path must be given for access
string	$locale	Locale has no effect for TMX because TMX defines all languages within the source file
array	$option	OPTIONAL Options to use

Exceptions

Zend_Translation_Exception

Returns

array

Definition at line 62 of file Tmx.php.

    {
        $this->_data = array();
        if (!is_readable($filename)) {
            #require_once 'Zend/Translate/Exception.php';
            throw new Zend_Translate_Exception('Translation file \'' . $filename . '\' is not readable.');
        }

        if (isset($options['useId'])) {
            $this->_useId = (boolean) $options['useId'];
        }

        $encoding = $this->_findEncoding($filename);
        $this->_file = xml_parser_create($encoding);
        xml_set_object($this->_file, $this);
        xml_parser_set_option($this->_file, XML_OPTION_CASE_FOLDING, 0);
        xml_set_element_handler($this->_file, "_startElement", "_endElement");
        xml_set_character_data_handler($this->_file, "_contentElement");

        try {
            Zend_Xml_Security::scanFile($filename);
        } catch (Zend_Xml_Exception $e) {
            #require_once 'Zend/Translate/Exception.php';
            throw new Zend_Translate_Exception(
                $e->getMessage()
            );
        }

        if (!xml_parse($this->_file, file_get_contents($filename))) {
            $ex = sprintf('XML error: %s at line %d of file %s',
                          xml_error_string(xml_get_error_code($this->_file)),
                          xml_get_current_line_number($this->_file),
                          $filename);
            xml_parser_free($this->_file);
            #require_once 'Zend/Translate/Exception.php';
            throw new Zend_Translate_Exception($ex);
        }

        return $this->_data;
    }

_startElement()

_startElement (   $file,   $name,   $attrib  )

protected

Internal method, called by xml element handler at start

Parameters

resource	$file	File handler
string	$name	Elements name
array	$attrib	Attributes for this element

Definition at line 110 of file Tmx.php.

    {
        if ($this->_seg !== null) {
            $this->_content .= "<".$name;
            foreach($attrib as $key => $value) {
                $this->_content .= " $key=\"$value\"";
            }
            $this->_content .= ">";
        } else {
            switch(strtolower($name)) {
                case 'header':
                    if (empty($this->_useId) && isset($attrib['srclang'])) {
                        if (Zend_Locale::isLocale($attrib['srclang'])) {
                            $this->_srclang = Zend_Locale::findLocale($attrib['srclang']);
                        } else {
                            if (!$this->_options['disableNotices']) {
                                if ($this->_options['log']) {
                                    $this->_options['log']->notice("The language '{$attrib['srclang']}' can not be set because it does not exist.");
                                } else {
                                    trigger_error("The language '{$attrib['srclang']}' can not be set because it does not exist.", E_USER_NOTICE);
                                }
                            }

                            $this->_srclang = $attrib['srclang'];
                        }
                    }
                    break;
                case 'tu':
                    if (isset($attrib['tuid'])) {
                        $this->_tu = $attrib['tuid'];
                    }
                    break;
                case 'tuv':
                    if (isset($attrib['xml:lang'])) {
                        if (Zend_Locale::isLocale($attrib['xml:lang'])) {
                            $this->_tuv = Zend_Locale::findLocale($attrib['xml:lang']);
                        } else {
                            if (!$this->_options['disableNotices']) {
                                if ($this->_options['log']) {
                                    $this->_options['log']->notice("The language '{$attrib['xml:lang']}' can not be set because it does not exist.");
                                } else {
                                    trigger_error("The language '{$attrib['xml:lang']}' can not be set because it does not exist.", E_USER_NOTICE);
                                }
                            }

                            $this->_tuv = $attrib['xml:lang'];
                        }

                        if (!isset($this->_data[$this->_tuv])) {
                            $this->_data[$this->_tuv] = array();
                        }
                    }
                    break;
                case 'seg':
                    $this->_seg     = true;
                    $this->_content = null;
                    break;
                default:
                    break;
            }
        }
    }

toString()

toString

(

)

Returns the adapter name

Returns

string

Definition at line 244 of file Tmx.php.

    {
        return "Tmx";
    }

---

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

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