Class: Translation2_Container_db

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

Class Overview

Translation2_Container
   |
   --Translation2_Container_db

Storage driver for fetching data from a database

Author(s):

Ian Eure <ieure at php.net>
Lorenzo Alberton <l.alberton at quipo.it>

Version:

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

Copyright:

2004-2008 Lorenzo Alberton, Ian Eure

Variables

Methods

Child classes:

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

Inherited Variables

Class: Translation2_Container

Translation2_Container::$options

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 60]
Storage driver for fetching data from a database

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

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

[ Top ]

Class Variables

$db = null

[line 68]

DB object

Type:

object

[ Top ]

Method Detail

fetchLangs [line 183]

PEAR_Error fetchLangs(
)

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

Return: on failure

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

[ Top ]

getOne [line 255]

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

Get a single item from the container

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 getPage(
[string
$pageID = null], [string
$langID = null])

Returns an array of the strings in the selected page

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 293]

string 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 87]

boolean|PEAR_Error init(
mixed
&$db)

Initialize the container

Return: object if something went wrong

Parameters:

mixed &$db — string DSN or object DB instance

[ Top ]

setCharset [line 167]

PEAR_Error setCharset(
string
$charset)

Set charset used to read/store the translations

Return: on failure

Overrides Translation2_Container::setCharset() (Set charset used to read/store the translations)

Parameters:

string $charset — character set (encoding)

[ Top ]