CmsNls View code

A class to provide data and methods for encapsulating a single language

author

Robert Campbell
since 1.11
package

CMS
license

GPL

Methods

matches(string $str) : boolean

Test if this NLS object matches the passed in string

Matches are achieved by checking name, isocode, fullname, and then aliases

Arguments

string $str

The test string

Response

boolean 

name() : string

Return the name of this Nls object

Response

string 

isocode() : string

Return this isocode of this Nls object

Response

string 

display() : string

Return the display string for this Nls object

Response

string 

locale() : string

Return the locale string for this Nls object

Response

string 

encoding() : string

Return the encoding for this Nls object (or UTF-8)

Response

string 

fullname() : string

Return the full name of this Nls object

Response

string 

aliases() : mixed

Return the aliases associated with this Nls object

Response

mixed

array of aliases, or null

key() : string

Return the key associated with this Nls object

Response

string 

direction() : string

Return the direction of this Nls object (ltr or rtl)

Response

string 

htmlarea() : string

Return the first two characters of the isocode for this Nls Object This is used typically for WYSIWYG text editors.

Response

string

Back to top