Class: Base_LangCommon

Source Location: /modules/Base/Lang/LangCommon_0.php

Class Base_LangCommon

Class Overview

This class provides translations manipulation.

Translation files are kept in 'modules/Lang/translations'. Http server user should have write access to those files.

Located in /modules/Base/Lang/LangCommon_0.php [line 21]

ModuleAcl
   |
   --ModulePrimitive
      |
      --ModuleCommon
         |
         --Base_LangCommon

Author(s):

Paul Bukowski <pbukowski@telaxus.com>

Information Tags:

Version:	1.0
Copyright:	Copyright © 2006, Telaxus LLC

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From ModuleCommon

ModuleCommon::Instance()

Singleton.

Inherited From ModulePrimitive

ModulePrimitive::__construct()

ModulePrimitive::check_access()

Checks access to function which name is passed as first parameter.

ModulePrimitive::create_data_dir()

Creates default data directory for module. Typical usage: in module installation

ModulePrimitive::get_data_dir()

Returns path to the default data directory for module calling this method.

ModulePrimitive::get_module_dir()

Returns path to the module directory.

ModulePrimitive::get_type()

Returns name(type) of module that called this function.

ModulePrimitive::get_type_with_bt()

ModulePrimitive::remove_data_dir()

Removes default data directory of a module. Typical usage: in module uninstallation

Inherited From ModuleAcl

ModuleAcl::acl_check()

ModuleAcl::add_aco()

ModuleAcl::del_aco()

ModuleAcl::get_type()

[ Top ]

Method Summary

static void	get_langpack()	For internal use only.
static void	get_lang_code()
static void	install_translations()	For internal use only.
static void	its()
static void	load()	For internal use only.
static void	new_langpack()	For internal use only.
static void	refresh_cache()
static void	save()	For internal use only.
static void	t()
static string	ts()	Use this function to translate desired string. Translation link is never shown.

[ Top ]

Methods

static method get_langpack [line 154]

static void get_langpack(

$code 
)

For internal use only.

Parameters:

$code:

API Tags:

Access:

public

[ Top ]

static method get_lang_code [line 108]

static void get_lang_code(
)

API Tags:

Access:

public

[ Top ]

static method install_translations [line 125]

static void install_translations(

$mod_name, [
$lang_dir = 'lang'] 
)

For internal use only.

Parameters:

	$mod_name:
	$lang_dir:

API Tags:

Access:

public

[ Top ]

static method its [line 72]

static void its(

$group, 
$original, [
$arg = array()] 
)

Parameters:

	$group:
	$original:
array	$arg:

API Tags:

Access:

public

[ Top ]

static method load [line 101]

static void load(
)

For internal use only.

API Tags:

Access:

public

[ Top ]

static method new_langpack [line 146]

static void new_langpack(

$code 
)

For internal use only.

Parameters:

$code:

API Tags:

Access:

public

[ Top ]

static method refresh_cache [line 163]

static void refresh_cache(
)

API Tags:

Access:

public

[ Top ]

static method save [line 79]

static void save(
[
$lang = null] 
)

For internal use only.

Parameters:

$lang:

API Tags:

Access:

public

[ Top ]

static method t [line 178]

static void t(

$original, [
$arg = array()] 
)

Parameters:

	$original:
array	$arg:

API Tags:

Access:

public

[ Top ]

static method ts [line 37]

static string ts(
string
$group, string
$original, [
$arg = array()], [
$hidden = true] 
)

Use this function to translate desired string. Translation link is never shown.

This function can be used with static functions, it doesn't require packing of 'Lang' module inside other. Example

 print(self::ts('group or parent module', 'some text'));

Note that it's slower then t function.

Parameters:

string	$group:	group or parent module
string	$original:	string to translate
array	$arg:
	$hidden:

API Tags:

Access:

public

[ Top ]

Documentation generated on Fri, 26 Dec 2008 21:42:49 -0500 by phpDocumentor 1.4.2

	epesi-base lang

[ class tree: epesi-base ] [ index: epesi-base ] [ all elements ]