Docs For Class Translation2

Class: Translation2_Admin

Class Details

[line 57]
Administration utilities for translation string management

Set of methods to easily add/remove languages and strings, with a common API for all the containers.

Author: Lorenzo Alberton <dot alberton at quipo dot it l dot alberton at quipo dot it>
Copyright: 2004-2005 Lorenzo Alberton
Link: http://pear.php.net/package/Translation2
License: BSD License (3 Clause)

Method Detail

add [line 253]

mixed add(
string
$stringID, [string
$pageID = null], array
$stringArray)

add a new translation

Return: true on success, PEAR_Error on failure

Parameters:

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

[ Top ]

addLang [line 177]

mixed addLang(
array
$langData)

Prepare the storage container for a new lang.

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

Return: true on success, PEAR_Error on failure

Parameters:

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

[ Top ]

cleanCache [line 324]

void cleanCache(
)

If you use the CacheLiteFunction decorator, you may want to invalidate the cache after a change in the data base.

[ Top ]

factory [line 78]

object Translation2 &factory(

$driver, [mixed
$options = ''], [array
$params = array()], string
$storageDriver)

Return a Translation2_Admin instance already initialized

Return: instance or PEAR_Error on failure
Access: public

Overrides Translation2::factory() (Return a Translation2 instance already initialized)

Parameters:

string	`$storageDriver`	—	Type of the storage driver
mixed	`$options`	—	Additional options for the storage driver (example: if you are using DB as the storage driver, you have to pass the dsn string here)
array	`$params`	—	Array of parameters for the adapter class (i.e. you can set here the mappings between your table/field names and the ones used by this class)
	`$driver`	—

[ Top ]

getAdminDecorator [line 149]

object Decorator &getAdminDecorator(
string
$decorator)

Return an instance of an admin decorator

Return: object reference
See: Translation2::getDecorator()
Access: public

Parameters:

string $decorator — Name of the decorator

[ Top ]

getPageNames [line 312]

array getPageNames(
)

Get a list of all the pageIDs in any table.

[ Top ]

remove [line 295]

mixed remove(
string
$stringID, [string
$pageID = null])

remove a translated string

Return: true on success, PEAR_Error on failure
Todo: add a third $langs option, to conditionally remove only the langs specified

Parameters:

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

[ Top ]

removeLang [line 207]

mixed removeLang(
[string
$langID = null], [boolean
$force = false])

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

Return: true on success, PEAR_Error on failure

Parameters:

string	`$langID`	—
boolean	`$force`	—

[ Top ]

update [line 275]

mixed update(
string
$stringID, [string
$pageID = null], array
$stringArray)

Update an existing translation

Return: true on success, PEAR_Error on failure
Author: Ian Eure

Parameters:

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

[ Top ]

updateLang [line 232]

mixed updateLang(
array
$langData)

Update the lang info in the langsAvail table

Return: true on success, PEAR_Error on failure

Parameters:

array $langData —

[ Top ]

Class: Translation2_Admin

Class Overview

Author(s):

Copyright:

Methods

Inherited Variables

Class: Translation2

Inherited Methods

Class: Translation2

Class Details

Method Detail

add [line 253]

Parameters:

addLang [line 177]

Parameters:

cleanCache [line 324]

factory [line 78]

Parameters:

getAdminDecorator [line 149]

Parameters:

getPageNames [line 312]

remove [line 295]

Parameters:

removeLang [line 207]

Parameters:

update [line 275]

Parameters:

updateLang [line 232]

Parameters: