apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]

Class: I18Nv2_CommonList

Source Location: /I18Nv2-0.11.4/CommonList.php

Class Overview


I18Nv2_CommonList


Author(s):

Version:

  • $Revision: 1.13 $

Variables

Methods


Child classes:

I18Nv2_Country
I18Nv2_Country
I18Nv2_Language
I18Nv2_Language
I18Nv2_Currency
I18Nv2_Currency
I18Nv2_AreaCode
I18Nv2_AreaCode

Inherited Variables

Inherited Methods


Class Details

[line 34]
I18Nv2_CommonList

Base class for I18Nv2_Country and I18Nv2_Language that performs some basic work, so code doesn't get written twice or even more often in the future.



[ Top ]


Class Variables

$codes = array()

[line 42]

Codes
  • Access: protected

Type:   array


[ Top ]

$encoding =  ''

[line 58]

Encoding
  • Access: protected

Type:   string


[ Top ]

$language =  ''

[line 50]

Language
  • Access: protected

Type:   string


[ Top ]



Method Detail

I18Nv2_CommonList (Constructor)   [line 67]

I18Nv2_CommonList I18Nv2_CommonList( [string $language = null], [string $encoding = null])

Constructor
  • Access: public

Parameters:

string   $language     
string   $encoding     

[ Top ]

changeKeyCase   [line 223]

string changeKeyCase( string $code)

Change Key Case
  • Access: protected

Overridden in child classes as:

I18Nv2_Country::changeKeyCase()
Change case of code key
I18Nv2_Language::changeKeyCase()
Change case of code key
I18Nv2_Currency::changeKeyCase()
Change case of code key
I18Nv2_AreaCode::changeKeyCase()
Change Key Case

Parameters:

string   $code     

[ Top ]

getAllCodes   [line 185]

array getAllCodes( )

Return all the codes
  • Return: all codes as associative array
  • Access: public

[ Top ]

getEncoding   [line 143]

string getEncoding( )

Get current encoding
  • Access: public

[ Top ]

getLanguage   [line 116]

string getLanguage( )

Get current language
  • Access: public

[ Top ]

getName   [line 167]

string getName( string $code)

Return corresponding name of code
  • Return: name
  • Access: public

Parameters:

string   $code     code

[ Top ]

isValidCode   [line 155]

bool isValidCode( string $code)

Check if code is valid
  • Access: public

Parameters:

string   $code     code

[ Top ]

loadLanguage   [line 211]

bool loadLanguage( string $language)

Load Language

Overridden in child classes as:

I18Nv2_Country::loadLanguage()
Load language file
I18Nv2_Language::loadLanguage()
Load language file
I18Nv2_Currency::loadLanguage()
Load language file
I18Nv2_AreaCode::loadLanguage()
Load Language

Parameters:

string   $language     

[ Top ]

setEncoding   [line 128]

bool setEncoding( string $encoding)

Set active encoding
  • Access: public

Parameters:

string   $encoding     

[ Top ]

setLanguage   [line 94]

bool setLanguage( string $language)

Set active language

Note that each time you set a different language the corresponding language file has to be loaded again, too.

  • Access: public

Parameters:

string   $language     

[ Top ]

toDecoratedList   [line 235]

object I18NV2_DecoratedList &toDecoratedList( string $type)

Decorate this list
  • Access: public

Parameters:

string   $type     

[ Top ]


Documentation generated on Wed, 08 Mar 2006 08:47:14 -0500 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.