Class: Translation2_Admin_Container_dataobjectsimple

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

Class Overview

Translation2_Container
   |
   --Translation2_Container_dataobjectsimple
      |
      --Translation2_Admin_Container_dataobjectsimple

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

Author(s):

Alan Knowles <alan at akbkhome.com>

Version:

CVS: $Id: dataobjectsimple.php,v 1.13 2006/07/06 09:21:09 quipo Exp $

Copyright:

2004-2005 Alan Knowles

Methods

Inherited Variables

Class: Translation2_Container

Translation2_Container::$options

Inherited Methods

Class: Translation2_Container_dataobjectsimple

Translation2_Container_dataobjectsimple::fetchLangs(): Fetch the available langs if they're not cached yet.
Translation2_Container_dataobjectsimple::getOne(): Get a single item from the container, without caching the whole page
Translation2_Container_dataobjectsimple::getPage(): Returns an array of the strings in the selected page
Translation2_Container_dataobjectsimple::getStringID(): Get the stringID for the given string
Translation2_Container_dataobjectsimple::init(): Initialize the container

Class: Translation2_Container

Translation2_Container::Translation2_Container(): Constructor
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::setLang(): Sets the current lang
Translation2_Container::_parseOptions(): Parse options passed to the container class

Class Details

[line 70]
Storage driver for storing/fetching data to/from a database

This storage driver can use all databases which are supported by PEAR::DB_DataObject to fetch data.

Database Structure:

 // meta data etc. not supported

 table: translations
  id          // not null primary key autoincrement..
  string_id   // translation id
  page        // indexed varchar eg. (mytemplate.html)
  lang        // index varchar (eg. en|fr|.....)
  translation // the translated value in language lang.

Author: Alan Knowles <alan@akbkhome.com>
Version: CVS: $Id: dataobjectsimple.php,v 1.13 2006/07/06 09:21:09 quipo Exp $
Copyright: 2004-2005 Alan Knowles
Link: http://pear.php.net/package/Translation2
License: BSD License (3 Clause)

[ Top ]

Method Detail

add [line 127]

true|PEAR_Error add(

$string, 
$page, array
$stringArray, string
$stringID, string
$pageID)

Add a new entry in the strings table.

Parameters:

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

[ Top ]

addLang [line 87]

true|PEAR_Error addLang(
array
$langData)

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

[ Top ]

addLangToList [line 110]

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

[ Top ]

remove [line 188]

true|PEAR_Error remove(
string
$stringID, string
$pageID)

Remove an entry from the strings table.

Parameters:

string	`$stringID`	—
string	`$pageID`	—

[ Top ]

update [line 172]

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

Update an existing entry in the strings table.

Parameters:

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

[ Top ]