Class: Translation2_Admin_Container_mdb2

Source Location: /Translation2-2.0.1/Admin/Container/mdb2.php

Class Overview

Translation2_Container
   |
   --Translation2_Container_mdb2
      |
      --Translation2_Admin_Container_mdb2

Storage driver for storing/fetching data to/from a database

Author(s):

Lorenzo Alberton <l.alberton at quipo.it>

Version:

CVS: $Id: mdb2.php,v 1.30 2008/05/03 09:17:59 quipo Exp $

Copyright:

2004-2007 Lorenzo Alberton

Methods

Inherited Variables

Class: Translation2_Container_mdb2

Translation2_Container_mdb2::$db

Class: Translation2_Container

Translation2_Container::$options

Inherited Methods

Class: Translation2_Container_mdb2

Translation2_Container_mdb2::fetchLangs(): Fetch the available langs if they're not cached yet.
Translation2_Container_mdb2::getOne(): Get a single item from the container
Translation2_Container_mdb2::getPage(): Returns an array of the strings in the selected page
Translation2_Container_mdb2::getStringID(): Get the stringID for the given string
Translation2_Container_mdb2::init(): Initialize the container
Translation2_Container_mdb2::setCharset(): Set charset used to read/store the translations

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 57]
Storage driver for storing/fetching data to/from a database

This storage driver can use all databases which are supported by the PEAR::MDB2 abstraction layer to store and fetch data.

Author: Lorenzo Alberton <l.alberton@quipo.it>
Version: CVS: $Id: mdb2.php,v 1.30 2008/05/03 09:17:59 quipo Exp $
Copyright: 2004-2007 Lorenzo Alberton
Link: http://pear.php.net/package/Translation2
License: BSD License (3 Clause)

[ Top ]

Method Detail

add [line 362]

true|PEAR_Error add(
string
$stringID, string
$pageID, array
$stringArray)

Add a new entry in the strings table.

Parameters:

string	`$stringID`	—	string ID
string	`$pageID`	—	page/group ID
array	`$stringArray`	—	Associative array with string translations. Sample format: array('en' => 'sample', 'it' => 'esempio')

[ Top ]

addLang [line 91]

true|PEAR_Error addLang(
array
$langData, [array
$options = array()])

Creates a new table to store the strings in this language.

If the table is shared with other langs, it is ALTERed to hold strings in this lang too.

Parameters:

array	`$langData`	—	array('lang_id' => 'en', 'table_name' => 'i18n', 'name' => 'english', 'meta' => 'some meta info', 'error_text' => 'not available');
array	`$options`	—	array('charset' => 'utf8', 'collation' => 'utf8_general_ci');

[ Top ]

addLangToList [line 201]

true|PEAR_Error addLangToList(
array
$langData)

Creates a new entry in the langsAvail table.

If the table doesn't exist yet, it is created.

Parameters:

array $langData — array('lang_id' => 'en', 'table_name' => 'i18n', 'name' => 'english', 'meta' => 'some meta info', 'error_text' => 'not available', 'encoding' => 'iso-8859-1');

[ Top ]

getPageNames [line 581]

array getPageNames(
)

Get a list of all the pageIDs in any table.

[ Top ]

remove [line 500]

mixed remove(
string
$stringID, string
$pageID)

Remove an entry from the strings table.

Return: true on success, PEAR_Error on failure

Parameters:

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

[ Top ]

removeLang [line 276]

true|PEAR_Error removeLang(
string
$langID, boolean
$force)

Remove the lang from the langsAvail table and drop the strings table.

If the strings table holds other langs and $force==false, then only the lang column is dropped. If $force==true the whole table is dropped without any check

Parameters:

string	`$langID`	—	language ID
boolean	`$force`	—	if true, the whole table is dropped without checks

[ Top ]

removePage [line 543]

mixed removePage(
[string
$pageID = null])

Remove all the strings in the given page/group

Return: true on success, PEAR_Error on failure

Parameters:

string $pageID — page/group ID

[ Top ]

update [line 413]

true|PEAR_Error update(
string
$stringID, string
$pageID, array
$stringArray)

Update an existing entry in the strings table.

Parameters:

string	`$stringID`	—	string ID
string	`$pageID`	—	page/group ID
array	`$stringArray`	—	Associative array with string translations. Sample format: array('en' => 'sample', 'it' => 'esempio')

[ Top ]

updateLang [line 316]

true|PEAR_Error updateLang(
array
$langData)

Update the lang info in the langsAvail table

Parameters:

array $langData — language data

[ Top ]