CmsNls
in package
A class to provide data and methods for encapsulating a single language
Tags
Table of Contents
Methods
- aliases() : mixed
- Return the aliases associated with this Nls object
- direction() : string
- Return the direction of this Nls object (ltr or rtl)
- display() : string
- Return the display string for this Nls object
- encoding() : string
- Return the encoding for this Nls object (or UTF-8)
- fullname() : string
- Return the full name of this Nls object
- htmlarea() : string
- Return the first two characters of the isocode for this Nls Object This is used typically for WYSIWYG text editors.
- isocode() : string
- Return this isocode of this Nls object
- key() : string
- Return the key associated with this Nls object
- locale() : string
- Return the locale string for this Nls object
- matches() : bool
- Test if this NLS object matches the passed in string
- name() : string
- Return the name of this Nls object
Methods
aliases()
Return the aliases associated with this Nls object
public
aliases() : mixed
Return values
mixed —array of aliases, or null
direction()
Return the direction of this Nls object (ltr or rtl)
public
direction() : string
Return values
stringdisplay()
Return the display string for this Nls object
public
display() : string
Return values
stringencoding()
Return the encoding for this Nls object (or UTF-8)
public
encoding() : string
Return values
stringfullname()
Return the full name of this Nls object
public
fullname() : string
Return values
stringhtmlarea()
Return the first two characters of the isocode for this Nls Object This is used typically for WYSIWYG text editors.
public
htmlarea() : string
Return values
stringisocode()
Return this isocode of this Nls object
public
isocode() : string
Return values
stringkey()
Return the key associated with this Nls object
public
key() : string
Return values
stringlocale()
Return the locale string for this Nls object
public
locale() : string
Return values
stringmatches()
Test if this NLS object matches the passed in string
public
matches(string $str) : bool
Matches are achieved by checking name, isocode, fullname, and then aliases
Parameters
- $str : string
-
The test string
Return values
boolname()
Return the name of this Nls object
public
name() : string