Package DE_EPAGES::Object::API::Table::Language
interface for table Language
Functions
- DeleteLanguage
- ExistsLanguage
- GetAllInfoLanguages
- GetAllPKeyLanguages
- GetInfoLanguage
- GetInfoLanguagesByCode2
- GetInfoLanguagesByCode3
- GetPKeyLanguagesByCode2
- GetPKeyLanguagesByCode3
- InsertLanguage
- UpdateLanguage
DeleteLanguage
Deletes a(n) Language.
Syntax |
DeleteLanguage($LanguageID);
DeleteLanguage($hLanguage); # if $hLanguage includes LanguageID
|
Input |
- $LanguageID (int)
- language id (primary key)
|
ExistsLanguage
Returns true if the Language exists.
Syntax |
$exists = ExistsLanguage($LanguageID);
|
Input |
- $LanguageID (int)
- language id
|
Return |
- $exists (boolean)
- 1/0 the Language exists (yes/no)
|
GetAllInfoLanguages
Returns all objects of Language.
Syntax |
$ahLanguages = GetAllInfoLanguages();
|
Return |
- $ahLanguages (reference to array of hashes)
- with following keys:
- LanguageID - language id (primary key)- int
- IsUsed - is used / enabled - bit
- Code2 - iso-639-1 language code (optional)- char(2)
- Code3 - iso-639-2 language code - char(3)
- English - english name of language (optional)- nvarchar(255)
- French - french name of language (optional)- nvarchar(255)
- Native - local name of language (optional)- nvarchar(255)
- DefaultLocaleID - default locale id (optional)- nvarchar(5)
- IsForBackoffice - true if is this languge also for the backoffice - bit
|
GetAllPKeyLanguages
Returns all Language identifiers.
Syntax |
$aLanguageIDs = GetAllPKeyLanguages();
|
Return |
- $aLanguageIDs (reference to array of int)
- language id
|
GetInfoLanguage
Returns the Language by identifier.
Syntax |
$hLanguage = GetInfoLanguage($LanguageID);
|
Input |
- $LanguageID (int)
- language id (primary key)
|
Return |
- $hLanguage (reference to hash)
- with following keys:
- LanguageID - language id (primary key)- int
- IsUsed - is used / enabled - bit
- Code2 - iso-639-1 language code (optional)- char(2)
- Code3 - iso-639-2 language code - char(3)
- English - english name of language (optional)- nvarchar(255)
- French - french name of language (optional)- nvarchar(255)
- Native - local name of language (optional)- nvarchar(255)
- DefaultLocaleID - default locale id (optional)- nvarchar(5)
- IsForBackoffice - true if is this languge also for the backoffice - bit
|
GetInfoLanguagesByCode2
Returns objects of Language by alternate key Code2.
Syntax |
$ahLanguages = GetInfoLanguagesByCode2($Code2);
|
Input |
- $Code2 (char(2))
- iso-639-1 language code
|
Return |
- $ahLanguages (reference to array of hashes)
- with following keys:
- LanguageID - language id (primary key)- int
- IsUsed - is used / enabled - bit
- Code2 - iso-639-1 language code (optional)- char(2)
- Code3 - iso-639-2 language code - char(3)
- English - english name of language (optional)- nvarchar(255)
- French - french name of language (optional)- nvarchar(255)
- Native - local name of language (optional)- nvarchar(255)
- DefaultLocaleID - default locale id (optional)- nvarchar(5)
- IsForBackoffice - true if is this languge also for the backoffice - bit
|
GetInfoLanguagesByCode3
Returns objects of Language by alternate key Code3.
Syntax |
$ahLanguages = GetInfoLanguagesByCode3($Code3);
|
Input |
- $Code3 (char(3))
- iso-639-2 language code
|
Return |
- $ahLanguages (reference to array of hashes)
- with following keys:
- LanguageID - language id (primary key)- int
- IsUsed - is used / enabled - bit
- Code2 - iso-639-1 language code (optional)- char(2)
- Code3 - iso-639-2 language code - char(3)
- English - english name of language (optional)- nvarchar(255)
- French - french name of language (optional)- nvarchar(255)
- Native - local name of language (optional)- nvarchar(255)
- DefaultLocaleID - default locale id (optional)- nvarchar(5)
- IsForBackoffice - true if is this languge also for the backoffice - bit
|
GetPKeyLanguagesByCode2
Returns primary keys of Language by alternate key Code2.
Syntax |
$aKeys = GetPKeyLanguagesByCode2($Code2);
|
Input |
- $Code2 (char(2))
- iso-639-1 language code
|
Return |
- $aKeys (reference to array of int)
- language id (primary key)
|
GetPKeyLanguagesByCode3
Returns primary keys of Language by alternate key Code3.
Syntax |
$aKeys = GetPKeyLanguagesByCode3($Code3);
|
Input |
- $Code3 (char(3))
- iso-639-2 language code
|
Return |
- $aKeys (reference to array of int)
- language id (primary key)
|
InsertLanguage
Creates an entry of Language.
Syntax |
$LanguageID = InsertLanguage($hLanguage);
|
Input |
- $hLanguage (reference to hash)
- with following keys:
- LanguageID - language id (primary key)(optional)- int
- IsUsed - is used / enabled - bit
- Code2 - iso-639-1 language code (optional)- char(2)
- Code3 - iso-639-2 language code - char(3)
- English - english name of language (optional)- nvarchar(255)
- French - french name of language (optional)- nvarchar(255)
- Native - local name of language (optional)- nvarchar(255)
- DefaultLocaleID - default locale id (optional)- nvarchar(5)
- IsForBackoffice - true if is this languge also for the backoffice - bit
|
Return |
- $LanguageID (int)
- language id (primary key)
|
UpdateLanguage
Updates a(n) Language if any element was changed.
Syntax |
UpdateLanguage($LanguageID, $hLanguage);
UpdateLanguage($hLanguage); # if $hLanguage includes LanguageID
|
Input |
- $LanguageID (int)
- language id (primary key)
- $hLanguage (reference to hash)
- with following keys:
- IsUsed - is used / enabled - bit
- Code2 - iso-639-1 language code (optional)- char(2)
- Code3 - iso-639-2 language code - char(3)
- English - english name of language (optional)- nvarchar(255)
- French - french name of language (optional)- nvarchar(255)
- Native - local name of language (optional)- nvarchar(255)
- DefaultLocaleID - default locale id (optional)- nvarchar(5)
- IsForBackoffice - true if is this languge also for the backoffice - bit
|