Zend_Translate Class Reference

Public Member Functions
	__construct ($options=array())
	setAdapter ($options=array())
	getAdapter ()
	__call ($method, array $options)

Static Public Member Functions
static	getCache ()
static	setCache (Zend_Cache_Core $cache)
static	hasCache ()
static	removeCache ()
static	clearCache ($tag=null)

Data Fields
const	AN_ARRAY = 'Array'
const	AN_CSV = 'Csv'
const	AN_GETTEXT = 'Gettext'
const	AN_INI = 'Ini'
const	AN_QT = 'Qt'
const	AN_TBX = 'Tbx'
const	AN_TMX = 'Tmx'
const	AN_XLIFF = 'Xliff'
const	AN_XMLTM = 'XmlTm'
const	LOCALE_DIRECTORY = 'directory'
const	LOCALE_FILENAME = 'filename'

Detailed Description

Definition at line 39 of file Translate.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = array()

)

Generates the standard translation object

Parameters

array | Zend_Config | Zend_Translate_Adapter	$options	Options to use
	string|array	[$content] Path to content, or content itself
	string|Zend_Locale	[$locale]

Exceptions

Zend_Translate_Exception

Definition at line 71 of file Translate.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } else if (func_num_args() > 1) {
            $args               = func_get_args();
            $options            = array();
            $options['adapter'] = array_shift($args);
            if (!empty($args)) {
                $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('adapter' => $options);
        }

        $this->setAdapter($options);
    }

Member Function Documentation

__call()

__call	(		$method,
		array	$options
	)

Calls all methods from the adapter

Definition at line 216 of file Translate.php.

    {
        if (method_exists($this->_adapter, $method)) {
            return call_user_func_array(array($this->_adapter, $method), $options);
        }
        #require_once 'Zend/Translate/Exception.php';
        throw new Zend_Translate_Exception("Unknown method '" . $method . "' called!");
    }

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 208 of file Translate.php.

    {
        Zend_Translate_Adapter::clearCache($tag);
    }

getAdapter()

getAdapter

(

)

Returns the adapters name and it's options

Returns

Zend_Translate_Adapter

Definition at line 156 of file Translate.php.

    {
        return $this->_adapter;
    }

getCache()

static getCache ( )

static

Returns the set cache

Returns

Zend_Cache_Core The set cache

Definition at line 166 of file Translate.php.

    {
        return Zend_Translate_Adapter::getCache();
    }

hasCache()

static hasCache ( )

static

Returns true when a cache is set

Returns

boolean

Definition at line 187 of file Translate.php.

    {
        return Zend_Translate_Adapter::hasCache();
    }

removeCache()

static removeCache ( )

static

Removes any set cache

Returns

void

Definition at line 197 of file Translate.php.

    {
        Zend_Translate_Adapter::removeCache();
    }

setAdapter()

setAdapter

(

$options = array()

)

Sets a new adapter

Parameters

array | Zend_Config | Zend_Translate_Adapter	$options	Options to use
	string|array	[$content] Path to content, or content itself
	string|Zend_Locale	[$locale]

Exceptions

Zend_Translate_Exception

Definition at line 106 of file Translate.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } else if (func_num_args() > 1) {
            $args               = func_get_args();
            $options            = array();
            $options['adapter'] = array_shift($args);
            if (!empty($args)) {
                $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('adapter' => $options);
        }

        if (Zend_Loader::isReadable('Zend/Translate/Adapter/' . ucfirst($options['adapter']). '.php')) {
            $options['adapter'] = 'Zend_Translate_Adapter_' . ucfirst($options['adapter']);
        }

        if (!class_exists($options['adapter'])) {
            Zend_Loader::loadClass($options['adapter']);
        }

        if (array_key_exists('cache', $options)) {
            Zend_Translate_Adapter::setCache($options['cache']);
        }

        $adapter = $options['adapter'];
        unset($options['adapter']);
        $this->_adapter = new $adapter($options);
        if (!$this->_adapter instanceof Zend_Translate_Adapter) {
            #require_once 'Zend/Translate/Exception.php';
            throw new Zend_Translate_Exception("Adapter " . $adapter . " does not extend Zend_Translate_Adapter");
        }
    }

setCache()

static setCache ( Zend_Cache_Core  $cache )

static

Sets a cache for all instances of Zend_Translate

Parameters

Zend_Cache_Core

$cache

Cache to store to

Returns

void

Definition at line 177 of file Translate.php.

    {
        Zend_Translate_Adapter::setCache($cache);
    }

Field Documentation

AN_ARRAY

const AN_ARRAY = 'Array'

Adapter names constants

Definition at line 43 of file Translate.php.

AN_CSV

const AN_CSV = 'Csv'

Definition at line 44 of file Translate.php.

AN_GETTEXT

const AN_GETTEXT = 'Gettext'

Definition at line 45 of file Translate.php.

AN_INI

const AN_INI = 'Ini'

Definition at line 46 of file Translate.php.

AN_QT

const AN_QT = 'Qt'

Definition at line 47 of file Translate.php.

AN_TBX

const AN_TBX = 'Tbx'

Definition at line 48 of file Translate.php.

AN_TMX

const AN_TMX = 'Tmx'

Definition at line 49 of file Translate.php.

AN_XLIFF

const AN_XLIFF = 'Xliff'

Definition at line 50 of file Translate.php.

AN_XMLTM

const AN_XMLTM = 'XmlTm'

Definition at line 51 of file Translate.php.

LOCALE_DIRECTORY

const LOCALE_DIRECTORY = 'directory'

Definition at line 53 of file Translate.php.

LOCALE_FILENAME

const LOCALE_FILENAME = 'filename'

Definition at line 54 of file Translate.php.

---

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

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