Log in
Forgot your password?
USAGE.txt
- USAGE
- EASYLANGUAGESERVICE API
Module Functions:
def getLanguageItems(spec=[]): """ Returns all languages as (RFC3066, PlainText) except for the once in filter. filter is a sequence of RFC3066 code. """
def getLanguageByRFC3066(code, default=English):
"""Translates a language code to a human readable form in english.
If a sequence of language codes is passed, a sequence of the corresponding languages is returns. """
def getLanguageByISO639_1(code, default=English):
"""Translates a language code to a human readable form in english.
If a sequence of language codes is passed, a sequence of the corresponding languages is returns. """
def getCountryByISO3166_1(code, default=United States):
"""Translates a language code to a human readable form in english.
If a sequence of language codes is passed, a sequence of the corresponding languages is returns. """
def getRFC3066ByLanguage(language, default=en):
"""Translates a language in a human readable form to the code.
"""
def getISO639_1ByLanguage(language, default=en):
"""Translates a language in a human readable form to the code."""
def getISO3166_1ByCountry(country, default=en):
"""Translates a language in a human readable form to the code."""
def getISO639_1ByRFC3066(code): """ Returns the root language class of the language code.
If a sequence of language codes is passed, a tuple of the corresponding languages is returns. """
def validISO639_1(code): """ Returnes true if this is a valid language code. """
def validRFC3066(code): """ Returnes true if this is a valid language code. """
def validISO3166_1(code): """ Returnes true if this is a valid language code. """
EasyLanguageService Class API
#Query Interface
security.declarePublic(getPreferredLanguagesName)
def getPreferredLanguagesName(self):
"""Returns the name of the preferred lanugage request attribute."""
security.declarePublic(getPreferredLanguages)
def getPreferredLanguages(self, object=None, use_substitute=1):
"""Returns the language code that would be most like
preferred by the user.
"""
security.declarePublic(getSubstitute)
def getSubstitute(self, languages=[]):
"""Substitutes language codes according to the language mapping."""
security.declarePublic(filterAllowed)
def filterAllowed(self, languages=[], default=['en']):
"""Filter languages that are defined with home pages (or none)"""
security.declarePublic(getPreferredLanguages)
def getAllowedPreferredLanguages(self, object=None, use_substitute=1, default=['en']):
"""Return allowed preferred languages."""
security.declarePublic(getPreferredFolder)
def getPreferredFolder(self, object=None, use_substitute=1, default=None):
"""Return the preferred languages folder object."""
security.declarePublic(getPreferredFolderAbsoluteURL)
def getPreferredFolderAbsoluteURL(self, object=None, use_substitute=1, default=None):
"""Return the absolute URL to preferred languages folder."""
security.declarePublic(getPreferredFolderURL)
def getPreferredFolderURL(self, object=None, use_substitute=1, default=None):
"""Return the virtual URL to preferred languages folder."""
# Action Interface
security.declarePublic(redirect)
def redirect(self, object=None, use_substitute=1, default=None, lock=1):
"""Redirect to the Language Folder, and ignore exceptions that may be raise after this."""
# Language Query Interface
security.declarePublic(getAllLanguage)
def getAllLanguage(self, filter=None):
"""
Returns all languages as (RFC3066, PlainText) except for the once in filter.
filter is a sequence of RFC3066 code. """
# Cookie Interface
security.declarePublic(setPreferredLanguagesCookie)
def setPreferredLanguagesCookie(self, language=None):
"""Sets a cookie with the preferred language."""
security.declarePublic(removePreferredLanguagesCookie)
def removePreferredLanguagesCookie(self):
"""Removes the cookie with the preferred language."""
security.declarePublic(getPreferredLanguagesCookie)
def getPreferredLanguagesCookie(self, default=en):
"""Gets the cookie with the preferred language or default."""
# RFC/ISO Query Interface
security.declarePublic(getLanguageByRFC3066)
def getLanguageByRFC3066(self, code, default=English):
"""Translates a language code to a human readable form in english.
If a sequence of language codes is passed, a sequence of the corresponding languages is returns. """
security.declarePublic(getLanguageByISO639_1)
def getLanguageByISO639_1(self, code, default=English):
"""Translates a language code to a human readable form in english.
If a sequence of language codes is passed, a sequence of the corresponding languages is returns. """
security.declarePublic(getCountryByISO3166_1)
def getCountryByISO3166_1(self, code, default=United States):
"""Translates a language code to a human readable form in english.
If a sequence of language codes is passed, a sequence of the corresponding languages is returns. """
security.declarePublic(getRFC3066ByLanguage)
def getRFC3066ByLanguage(self, language, default=en):
"""Translates a language in a human readable form to the code.
"""
security.declarePublic(getISO639_1ByLanguage)
def getISO639_1ByLanguage(self, language, default=en):
"""Translates a language in a human readable form to the code."""
security.declarePublic(getISO3166_1ByCountry)
def getISO3166_1ByCountry(self, country, default=en):
"""Translates a language in a human readable form to the code."""
security.declarePublic(getISO639_1ByRFC3066)
def getISO639_1ByRFC3066(self, code):
"""
Returns the root language class of the language code.
If a sequence of language codes is passed, a tuple of the corresponding languages is returns. """
security.declarePublic(validISO639_1)
def validISO639_1(self, code):
"""
Returnes true if this is a valid language code.
"""
security.declarePublic(validRFC3066)
def validRFC3066(self, code):
"""
Returnes true if this is a valid language code.
"""
security.declarePublic(validISO3166_1)
def validISO3166_1(self, code):
"""
Returnes true if this is a valid language code.
"""
security.declarePublic(relativeUrl)
def relativeUrl(self, absolute_url, REQUEST=None):
security.declarePublic(getLanguageFolderItems)
def getLanguageFolderItems(self,spec=None):
security.declarePublic(getLanguageFolderKeys)
def getLanguageFolderKeys(self, spec=[]):
security.declarePublic(getLanguageMappingItems)
def getLanguageMappingItems(self,spec=None):
security.declarePublic(getLanguageMappingKeys)
def getLanguageMappingKeys(self,spec=None):
security.declarePublic(getLanguageMappingUsedKeys)
def getLanguageMappingUsedKeys(self,spec=[]):
"""Returns all unique ids that has a mapping or is mapped from."""
security.declarePublic(getLanguageMappedKeys)
def getLanguageMappedKeys(self):
"""Returns all unique ids that is mapping to another language."""
security.declarePublic(getLanguageItems)
def getLanguageItems(self, spec=[]):
"""Returns all languages as (rfc3066Code, PlainText)"""