Class: Translation2_Container_dataobjectsimple

Source Location: /Translation2-2.0.0/Container/dataobjectsimple.php

Class Overview

Translation2_Container
   |
   --Translation2_Container_dataobjectsimple

Simple storage driver for fetching data from a db with DB_DataObject

Author(s):

Alan Knowles <alan at akbkhome.com>

Version:

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

Copyright:

2004-2008 Alan Knowles

Child classes:

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

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 77]
Simple storage driver for fetching data from a db with DB_DataObject

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

Database Structure:

  // meta data etc. not supported yet...

  create table translations (
     id int(11) auto_increment not null primary key,
     string_id int(11),
     page varchar(128),
     lang varchar(10),
     translation text
     );
 alter table translations add index page (page);
 alter table translations add index lang (lang);
 alter table translations add index string_id (string_id);

then just run the dataobjects createtables script.

Author: Alan Knowles <alan@akbkhome.com>
Version: CVS: $Id: dataobjectsimple.php,v 1.17 2008/02/02 18:05:06 quipo Exp $
Copyright: 2004-2008 Alan Knowles
Link: http://pear.php.net/package/Translation2
License: BSD License (3 Clause)

[ Top ]

Method Detail

fetchLangs [line 119]

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

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

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

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

boolean init(
[string
$table = null])

Initialize the container

Return: true

Parameters:

string $table — table name

[ Top ]