Class: Translation2_Container_gettext

Source Location: /Translation2-2.0.1/Container/gettext.php

Class Overview

Translation2_Container
   |
   --Translation2_Container_gettext

Storage driver for fetching data with gettext

Author(s):

Michael Wallner <mike at php.net>
Lorenzo Alberton <l.alberton at quipo.it>

Version:

CVS: $Id: gettext.php,v 1.32 2008/02/02 18:05:06 quipo Exp $

Copyright:

2004-2008 Lorenzo Alberton, Michael Wallner

Child classes:

Translation2_Admin_Container_gettext: Storage driver for storing/fetching data to/from a gettext file

Inherited Variables

Inherited Methods

Class: Translation2_Container

Translation2_Container::Translation2_Container(): Constructor Has to be overwritten by each storage class
Translation2_Container::fetchLangs(): Fetch the available langs if they're not cached yet.
Translation2_Container::getLang(): Gets the current lang
Translation2_Container::getLangData(): Gets the array data for the lang
Translation2_Container::getLangs(): Gets the available languages
Translation2_Container::getOne(): Get a single item from the container, without caching the whole page Containers should implement this method.
Translation2_Container::getPage(): Returns an array of the strings in the selected page Containers should implement this method.
Translation2_Container::getStringID(): Get the stringID for the given string
Translation2_Container::raiseError(): Trigger a PEAR error
Translation2_Container::setCharset(): Set charset used to read/store the translations
Translation2_Container::setLang(): Sets the current language
Translation2_Container::_parseOptions(): Parse options passed to the container class

Class Details

[line 66]
Storage driver for fetching data with gettext

This storage driver requires the gettext extension and the PEAR::I18Nv2 class for locale handling

Author: Michael Wallner <mike@php.net>
Author: Lorenzo Alberton <l.alberton@quipo.it>
Version: CVS: $Id: gettext.php,v 1.32 2008/02/02 18:05:06 quipo Exp $
Copyright: 2004-2008 Lorenzo Alberton, Michael Wallner
See: /docs/gettext_readme.txt for an usage example
Link: http://pear.php.net/package/Translation2
License: BSD License (3 Clause)

[ Top ]

Method Detail

fetchLangs [line 179]

void fetchLangs(
)

Fetch the available langs if they're not cached yet.

Overrides Translation2_Container::fetchLangs() (Fetch the available langs if they're not cached yet.)

[ Top ]

getOne [line 282]

string getOne(
string
$stringID, [string
$pageID = null], [string
$langID = null])

Get a single item from the container, without caching the whole page

Overrides Translation2_Container::getOne() (Get a single item from the container, without caching the whole page Containers should implement this method.)

Parameters:

string	`$stringID`	—	string ID
string	`$pageID`	—	page/group ID
string	`$langID`	—	language ID

[ Top ]

getPage [line 216]

array|PEAR_Error getPage(
[string
$pageID = null], [string
$langID = null])

Get all the strings from a domain (parsing the .mo file)

Overrides Translation2_Container::getPage() (Returns an array of the strings in the selected page Containers should implement this method.)

Parameters:

string	`$pageID`	—	page/group ID
string	`$langID`	—	language ID

[ Top ]

getStringID [line 330]

string|PEAR_Error getStringID(
string
$string, [string
$pageID = null])

Get the stringID for the given string

Overrides Translation2_Container::getStringID() (Get the stringID for the given string)

Parameters:

string	`$string`	—	string
string	`$pageID`	—	page/group ID

[ Top ]

init [line 99]

boolean|PEAR_Error init(
array
$options)

Initialize the container

Return: object if domains INI file doesn't exist

Parameters:

array $options — gettext parameters

[ Top ]

setLang [line 197]

array setLang(
string
$langID)

Sets the current lang

Return: language data

Overrides Translation2_Container::setLang() (Sets the current language)

Parameters:

string $langID — language ID

[ Top ]