Translate/Adapter/Tbx.php

Show:

inherited

Classes
- \Zend_Translate_Adapter_Tbx

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Translate
Version: $Id: Tbx.php 24649 2012-02-26 03:37:54Z adamlundrigan $

\Zend_Translate_Adapter_Tbx
jump to top

Package: Zend\Translate

Basic adapter class for each translation source adapter

Parent(s): \Zend_Translate_Adapter
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                LOCALE_DIRECTORY
                = 'directory'

inherited

Scans for the locale within the name of the directory

Inherited from: \Zend_Translate_Adapter::LOCALE_DIRECTORY

Constant: integer
Inherited_from: \Zend_Translate_Adapter::LOCALE_DIRECTORY

 
                LOCALE_FILENAME
                = 'filename'

inherited

Scans for the locale within the name of the file

Inherited from: \Zend_Translate_Adapter::LOCALE_FILENAME

Constant: integer
Inherited_from: \Zend_Translate_Adapter::LOCALE_FILENAME

Properties

boolean $_automatic = true

inherited

Shows if locale detection is in automatic level

Inherited from: \Zend_Translate_Adapter::$$_automatic

Default valuetrueDetails

Type: boolean
Inherited_from: \Zend_Translate_Adapter::$$_automatic

\Zend_Cache_Core $_cache = null

staticinherited

Internal cache for all adapters

Inherited from: \Zend_Translate_Adapter::$$_cache

Default valuenullDetails

Type: \Zend_Cache_Core
Inherited_from: \Zend_Translate_Adapter::$$_cache

boolean $_cacheTags = false

staticinherited

Internal value to remember if cache supports tags

Inherited from: \Zend_Translate_Adapter::$$_cacheTags

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Translate_Adapter::$$_cacheTags

$_cleared = array()

Default valuearray()Details

Type: n/a

$_content = null

Default valuenullDetails

Type: n/a

$_data = array()

Default valuearray()Details

Type: n/a

$_file = false

Default valuefalseDetails

Type: n/a

$_langset = null

Default valuenullDetails

Type: n/a

array $_options = 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')

inherited

Array with all options, each adapter can have own additional options 'clear' => when true, clears already loaded translations when adding new files 'content' => content to translate or file or directory with content 'disableNotices' => when true, omits notices from being displayed 'ignore' => a prefix for files and directories which are not being added 'locale' => the actual set locale to use 'log' => a instance of Zend_Log where logs are written to 'logMessage' => message to be logged 'logPriority' => priority which is used to write the log message 'logUntranslated' => when true, untranslated messages are not logged 'reload' => reloads the cache by reading the content again 'scan' => searches for translation files using the LOCALE constants 'tag' => tag to use for the cache

Inherited from: \Zend_Translate_Adapter::$$_options

Default 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')

Details

Type: array
Inherited_from: \Zend_Translate_Adapter::$$_options

\array() $_routed = array()

inherited

Internal value to see already routed languages

Inherited from: \Zend_Translate_Adapter::$$_routed

Default valuearray()Details

Type: \array()
Inherited_from: \Zend_Translate_Adapter::$$_routed

$_term = null

Default valuenullDetails

Type: n/a

$_termentry = null

Default valuenullDetails

Type: n/a

array $_translate = array()

inherited

Translation table

Inherited from: \Zend_Translate_Adapter::$$_translate

Default valuearray()Details

Type: array
Inherited_from: \Zend_Translate_Adapter::$$_translate

Methods

_(string $messageId, string | \Zend_Locale $locale = null) : string

inherited

Translates the given string returns the translation

Inherited from: \Zend_Translate_Adapter::_()

Parameters

Name	Type	Description
$messageId	string	Translation string
$locale	string \| \Zend_Locale	(optional) Locale/Language to use, identical with locale identifier, @see Zend_Locale for more information

Returns

Type	Description
string

__construct(array | \Zend_Config $options = array()) : void

inherited

Generates the adapter

Inherited from: \Zend_Translate_Adapter::__construct()

Parameters

Name	Type	Description
$options	array \| \Zend_Config	Translation options for this adapter

Throws

Exception	Description
\Zend_Translate_Exception

_addTranslationData( $options = array()) : \Zend_Translate_Adapter

inherited

Internal function for adding translation data

Inherited from: \Zend_Translate_Adapter::_addTranslationData()

This may be a new language or additional data for an existing language If the options 'clear' is true, then the translation data for the specified language is replaced and added otherwise

Parameters

Name	Type	Description
$options

Returns

Type	Description
\Zend_Translate_Adapter	Provides fluent interface

Throws

Exception	Description
\Zend_Translate_Exception

Details

See: \global\Zend_Locale

_contentElement( $file, $data) : void

Parameters

Name	Type	Description
$file
$data

_endElement( $file, $name) : void

Parameters

Name	Type	Description
$file
$name

_findEncoding( $filename) : void

Parameters

Name	Type	Description
$filename

_getTagSupportForCache() : void

staticinherited

Internal method to check if the given cache supports tags

Inherited from: \Zend_Translate_Adapter::_getTagSupportForCache()

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

Load translation data (TBX file reader)

Parameters

Name	Type	Description
$filename	string	TBX file to add, full path must be given for access
$locale	string	Locale has no effect for TBX because TBX defines all languages within the source file
$options

Returns

Type	Description
array

Throws

Exception	Description
\Zend_Translation_Exception

_log(string $message, String $locale) : void

inherited

Logs a message when the log option is set

Inherited from: \Zend_Translate_Adapter::_log()

Parameters

Name	Type	Description
$message	string	Message to log
$locale	String	Locale to log

_startElement( $file, $name, $attrib) : void

Parameters

Name	Type	Description
$file
$name
$attrib

addTranslation(array | \Zend_Config $options = array()) : \Zend_Translate_Adapter

inherited

Add translations

Inherited from: \Zend_Translate_Adapter::addTranslation()

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

Name	Type	Description
$options	array \| \Zend_Config	Options and translations to be added

Returns

Type	Description
\Zend_Translate_Adapter	Provides fluent interface

Throws

Exception	Description
\Zend_Translate_Exception

clearCache(string $tag = null) : void

staticinherited

Clears all set cache data

Inherited from: \Zend_Translate_Adapter::clearCache()

Parameters

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

getCache() : \Zend_Cache_Core

staticinherited

Returns the set cache

Inherited from: \Zend_Translate_Adapter::getCache()

Returns

Type	Description
\Zend_Cache_Core	The set cache

getList() : array | null

inherited

Returns the available languages from this adapter

Inherited from: \Zend_Translate_Adapter::getList()

Returns

Type	Description
array \| null

getLocale() : \Zend_Locale | string | null

inherited

Gets locale

Inherited from: \Zend_Translate_Adapter::getLocale()

Returns

Type	Description
\Zend_Locale \| string \| null

getMessageId(string $message, string | \Zend_Locale $locale = null) : string | array | false

inherited

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

Inherited from: \Zend_Translate_Adapter::getMessageId()

Parameters

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

Returns

Type	Description
string \| array \| false

getMessageIds(string | \Zend_Locale $locale = null) : array

inherited

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

Inherited from: \Zend_Translate_Adapter::getMessageIds()

Parameters

Name	Type	Description
$locale	string \| \Zend_Locale	(optional) Language to return the message ids from

Returns

Type	Description
array

getMessages(string | \Zend_Locale $locale = null) : array

inherited

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

Inherited from: \Zend_Translate_Adapter::getMessages()

Parameters

Name	Type	Description
$locale	string \| \Zend_Locale	(optional) Language to return the messages from

Returns

Type	Description
array

getOptions(string | null $optionKey = null) : integer | string | array | null

inherited

Returns the adapters name and it's options

Inherited from: \Zend_Translate_Adapter::getOptions()

Parameters

Name	Type	Description
$optionKey	string \| null	String returns this option null returns all options

Returns

Type	Description
integer \| string \| array \| null

hasCache() : boolean

staticinherited

Returns true when a cache is set

Inherited from: \Zend_Translate_Adapter::hasCache()

Returns

Type	Description
boolean

isAvailable(string | \Zend_Locale $locale) : boolean

inherited

Is the wished language available ?

Inherited from: \Zend_Translate_Adapter::isAvailable()

Parameters

Name	Type	Description
$locale	string \| \Zend_Locale	Language to search for, identical with locale identifier,

Returns

Type	Description
boolean

Details

See: \global\Zend_Locale
See: \global\Zend_Locale

isTranslated(string $messageId, boolean $original = false, string | \Zend_Locale $locale = null) : boolean

inherited

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

Inherited from: \Zend_Translate_Adapter::isTranslated()

Parameters

Name	Type	Description
$messageId	string	Translation string
$original	boolean	(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
$locale	string \| \Zend_Locale	(optional) Locale/Language to use, identical with locale identifier, see Zend_Locale for more information

Returns

Type	Description
boolean

plural(string $singular, string $plural, integer $number, string | \Zend_Locale $locale = null) : string

inherited

Translates the given string using plural notations Returns the translated string

Inherited from: \Zend_Translate_Adapter::plural()

Parameters

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

Returns

Type	Description
string

Details

See: \global\Zend_Locale

removeCache() : void

staticinherited

Removes any set cache

Inherited from: \Zend_Translate_Adapter::removeCache()

setCache(\Zend_Cache_Core $cache) : void

staticinherited

Sets a cache for all Zend_Translate_Adapters

Inherited from: \Zend_Translate_Adapter::setCache()

Parameters

Name	Type	Description
$cache	\Zend_Cache_Core	Cache to store to

setLocale(string | \Zend_Locale $locale) : \Zend_Translate_Adapter

inherited

Sets locale

Inherited from: \Zend_Translate_Adapter::setLocale()

Parameters

Name	Type	Description
$locale	string \| \Zend_Locale	Locale to set

Returns

Type	Description
\Zend_Translate_Adapter	Provides fluent interface

Throws

Exception	Description
\Zend_Translate_Exception

setOptions(array $options = array()) : \Zend_Translate_Adapter

inherited

Sets new adapter options

Inherited from: \Zend_Translate_Adapter::setOptions()

Parameters

Name	Type	Description
$options	array	Adapter options

Returns

Type	Description
\Zend_Translate_Adapter	Provides fluent interface

Throws

Exception	Description
\Zend_Translate_Exception

toString() : string

Returns the adapter name

Returns

Type	Description
string

translate(string | array $messageId, string | \Zend_Locale $locale = null) : string

inherited

Translates the given string returns the translation

Inherited from: \Zend_Translate_Adapter::translate()

Parameters

Name	Type	Description
$messageId	string \| array	Translation string, or Array for plural translations
$locale	string \| \Zend_Locale	(optional) Locale/Language to use, identical with locale identifier, @see Zend_Locale for more information

Returns

Type	Description
string

Details

See: \global\Zend_Locale

Translate/Adapter/Tbx.php

\Zend_Translate_Adapter_Tbxjump to top

Constants

Properties

Methods

\Zend_Translate_Adapter_Tbx
jump to top