/sources/lang3.php

Description
Functions
parse_translated_text (line 298)

get_translated_tempcode was asked for a lang entry that had not been parsed into Tempcode yet.

  • return: The parsed comcode (NULL: the text couldn't be looked up)
?tempcode parse_translated_text (integer $entry, ?object $connection, ?LANGUAGE_NAME $lang, boolean $force, boolean $as_admin)
  • integer $entry: The id
  • ?object $connection: The database connection to use (NULL: standard site connection)
  • ?LANGUAGE_NAME $lang: The language (NULL: uses the current language)
  • boolean $force: Whether to force it to the specified language
  • boolean $as_admin: Whether to force as_admin, even if the lang string isn't stored against an admin (designed for comcode page cacheing)
_comcode_lang_string (line 409)

Convert a language string that is Comcode to tempcode, with potential cacheing in the db.

  • return: The parsed Comcode
tempcode _comcode_lang_string (ID_TEXT $lang_code)
  • ID_TEXT $lang_code: The language string ID
_find_all_langs (line 27)

Get an array of all the installed languages that can be found in root/lang/ and root/lang_custom/

  • return: The installed languages (map, lang=>type)
array _find_all_langs ([boolean $even_empty_langs = false])
  • boolean $even_empty_langs: Whether to even find empty languages
_insert_lang (line 160)

Insert a language entry into the translation table, and returns the id.

  • return: The id of the newly added language entry
integer _insert_lang (string $text, integer $level, [?object $connection = NULL], [boolean $comcode = false], [?integer $id = NULL], [?LANGUAGE_NAME $lang = NULL], [boolean $insert_as_admin = false], [?string $pass_id = NULL], [?string $text2 = NULL], [integer $wrap_pos = 60], [boolean $preparse_mode = true], [boolean $save_as_volatile = false])
  • string $text: The text
  • integer $level: The level of importance this language string holds
  • ?object $connection: The database connection to use (NULL: standard site connection)
  • boolean $comcode: Whether it is to be parsed as comcode
  • ?integer $id: The id to use for the language entry (NULL: work out next available)
  • ?LANGUAGE_NAME $lang: The language (NULL: uses the current language)
  • boolean $insert_as_admin: Whether to insert it as an admin (any comcode parsing will be carried out with admin privileges)
  • ?string $pass_id: The special identifier for this lang code on the page it will be displayed on; this is used to provide an explicit binding between languaged elements and greater templated areas (NULL: none)
  • ?string $text2: Assembled Tempcode portion (NULL: work it out)
  • integer $wrap_pos: Comcode parser wrap position
  • boolean $preparse_mode: Whether to generate a fatal error if there is invalid Comcode
  • boolean $save_as_volatile: Whether we are saving as a 'volatile' file extension (used in the XML DB driver, to mark things as being non-syndicated to subversion)
_lang_remap (line 232)

Remap the specified language id, and return the id again - the id isn't changed.

  • return: The language entries id
integer _lang_remap (integer $id, string $text, [?object $connection = NULL], [boolean $comcode = false], [?string $pass_id = NULL], [?MEMBER $source_member = NULL], [boolean $as_admin = false], [boolean $backup_string = false])
  • integer $id: The language entries id
  • string $text: The text to remap to
  • ?object $connection: The database connection to use (NULL: standard site connection)
  • boolean $comcode: Whether it is to be parsed as comcode
  • ?string $pass_id: The special identifier for this lang code on the page it will be displayed on; this is used to provide an explicit binding between languaged elements and greater templated areas (NULL: none)
  • ?MEMBER $source_member: The member performing the change (NULL: current member)
  • boolean $as_admin: Whether to generate Comcode as arbitrary admin
  • boolean $backup_string: Whether to backup the language string before changing it
_nice_get_langs (line 108)

Get a nice formatted XHTML listed language selector.

  • return: The language selector
tempcode _nice_get_langs ([?LANGUAGE_NAME $select_lang = NULL], [boolean $show_unset = false])
  • ?LANGUAGE_NAME $select_lang: The language to have selected by default (NULL: uses the current language)
  • boolean $show_unset: Whether to show languages that have no language details currently defined for them

Documentation generated on Sun, 02 Jan 2011 23:17:01 +0000 by phpDocumentor 1.4.3