I18Nv2
[ class tree: I18Nv2 ] [ index: I18Nv2 ] [ all elements ]
Packages:
I18Nv2


Classes:
I18Nv2
I18Nv2_AreaCode
I18Nv2_Country
I18Nv2_Currency
I18Nv2_DecoratedList
I18Nv2_DecoratedList_AfricanCountries
I18Nv2_DecoratedList_AsianCountries
I18Nv2_DecoratedList_EuropeanCountries
I18Nv2_DecoratedList_Filter
I18Nv2_DecoratedList_HtmlEntities
I18Nv2_DecoratedList_HtmlSelect
I18Nv2_DecoratedList_HtmlSpecialchars
I18Nv2_DecoratedList_NorthAmericanCountries
I18Nv2_DecoratedList_OceanianCountries
I18Nv2_DecoratedList_SouthAmericanCountries
I18Nv2_Encoding
I18Nv2_Language
I18Nv2_Locale
I18Nv2_Negotiator
Files:
aa.php
aa.php
aa.php
af.php
af.php
af.php
af.php
AfricanCountries.php
am.php
am.php
am.php
ar.php
ar.php
ar.php
AreaCode.php
as.php
as.php
as.php
AsianCountries.php
az.php
az.php
az.php
be.php
be.php
be.php
bg.php
bg.php
bg.php
bn.php
bn.php
bn.php
ca.php
ca.php
ca.php
CommonList.php
Country.php
cs.php
cs.php
cs.php
cs.php
Currency.php
cy.php
cy.php
cy.php
da.php
da.php
da.php
da.php
de.php
de.php
de.php
de.php
DecoratedList.php
de_AT.php
de_DE.php
dv.php
dv.php
dv.php
dz.php
dz.php
dz.php
el.php
el.php
el.php
el_GR.php
en.php
en.php
en.php
en.php
Encoding.php
en_IE.php
eo.php
eo.php
eo.php
es.php
es.php
es.php
es.php
es_ES.php
et.php
et.php
et.php
eu.php
eu.php
eu.php
EUR.php
EuropeanCountries.php
fa.php
fa.php
fa.php
fi.php
fi.php
fi.php
Filter.php
fi_FI.php
fo.php
fo.php
fo.php
fr.php
fr.php
fr.php
fr.php
fr_BE.php
fr_FR.php
fr_LU.php
fr_MC.php
ga.php
ga.php
ga.php
gl.php
gl.php
gl.php
gu.php
gu.php
gu.php
gv.php
gv.php
gv.php
he.php
he.php
he.php
hi.php
hi.php
hi.php
hr.php
hr.php
hr.php
HtmlEntities.php
HtmlSelect.php
HtmlSpecialchars.php
hu.php
hu.php
hu.php
hu.php
hy.php
hy.php
hy.php
I18Nv2.php
I18Nv2_Locale-PHPUnit_Testcase.php
id.php
id.php
id.php
is.php
is.php
is.php
it.php
it.php
it.php
it.php
it_IT.php
iu.php
iu.php
iu.php
ja.php
ja.php
ja.php
ka.php
ka.php
ka.php
kk.php
kk.php
kk.php
kl.php
kl.php
kl.php
km.php
km.php
km.php
kn.php
kn.php
kn.php
ko.php
ko.php
ko.php
kw.php
kw.php
kw.php
ky.php
ky.php
ky.php
Language.php
lo.php
lo.php
lo.php
Locale.php
lt.php
lt.php
lt.php
lv.php
lv.php
lv.php
mk.php
mk.php
mk.php
ml.php
ml.php
ml.php
mn.php
mn.php
mn.php
mr.php
mr.php
mr.php
ms.php
ms.php
ms.php
mt.php
mt.php
mt.php
nb.php
nb.php
nb.php
nb.php
Negotiator.php
nl.php
nl.php
nl.php
nl.php
nl_BE.php
nl_NL.php
nn.php
nn.php
nn.php
nn.php
no.php
NorthAmericanCountries.php
OceanianCountries.php
om.php
om.php
om.php
or.php
or.php
or.php
pa.php
pa.php
pa.php
pl.php
pl.php
pl.php
pl.php
ps.php
ps.php
ps.php
pt.php
pt.php
pt.php
pt.php
pt_PT.php
retrieving_locale_conventions.php
ro.php
ro.php
ro.php
ru.php
ru.php
ru.php
ru.php
sa.php
sa.php
sa.php
setting_a_locale.php
sh.php
sh.php
sh.php
sk.php
sk.php
sk.php
sl.php
sl.php
sl.php
sl.php
so.php
so.php
so.php
SouthAmericanCountries.php
sq.php
sq.php
sq.php
sr.php
sr.php
sr.php
sv.php
sv.php
sv.php
sv_FI.php
sw.php
sw.php
sw.php
ta.php
ta.php
ta.php
te.php
te.php
te.php
th.php
th.php
th.php
ti.php
ti.php
ti.php
tr.php
tr.php
tr.php
transform_output_charset.php
tt.php
tt.php
tt.php
uk.php
uk.php
uk.php
ur.php
ur.php
ur.php
using_I18Nv2_Country.php
using_I18Nv2_DecoratedList.php
using_I18Nv2_Language.php
using_I18Nv2_Locale.php
using_I18Nv2_Negotiator.php
uz.php
uz.php
uz.php
vi.php
vi.php
vi.php
Windows.php
zh.php
zh.php
zh.php

Class: I18Nv2_Locale

Source Location: /I18Nv2-0.11.3/Locale.php

Class Overview




I18Nv2_Locale




Author(s):






        
        

Version:


    
  
  • $Revision: 1.31 $
    • 








Variables






Methods

















Inherited Variables





Inherited Methods














Class Details



[line 54]

I18Nv2_Locale









[ Top ]







Class Variables



	
	

	
$abbrDays = array()

	
[line 86]

  Abbreviated day names


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$abbrMonths = array()

	
[line 94]

  Abbreviated month names


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$cache = array()

	
[line 190]

  Locale Data Cache


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$currencyFormats = array()

	
[line 134]

  Registered currency formats


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$currentCurrencyFormat =  null

	
[line 174]

  Current currency format


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$currentDateFormat =  null

	
[line 150]

  Current date format


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$currentDateTimeFormat =  null

	
[line 158]

  Current datetime format


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$currentNumberFormat =  null

	
[line 166]

  Current number format


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$currentTimeFormat =  null

	
[line 142]

  Current time format


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$customFormats = array()

	
[line 182]

  Custom formats


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$dateFormats = array()

	
[line 102]

  Registered date formats


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$dateTimeFormats = array()

	
[line 118]

  Registered datetime formats


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$days = array()

	
[line 70]

  Full day names


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$initialized =  ''

	
[line 62]

  Initialized Locale


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$months = array()

	
[line 78]

  Full month names


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$numberFormats = array()

	
[line 126]

  Registered number formats


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$paranoid =  false

	
[line 198]

  Whether to reset the global locale after each call


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      bool
    

      

	



	
[ Top ]


	
	

	
$timeFormats = array()

	
[line 110]

  Registered time formats


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$usedLocale =  ''

	
[line 206]

  Store system locale for paranoid mode


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]










Method Detail



	
	
I18Nv2_Locale (Constructor)   [line 214]

	

    

    

		I18Nv2_Locale I18Nv2_Locale(
[string
$locale = null], [mixed
$paranoid = false])
    

    


	
		Constructor


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $locale  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
date   [line 799]

	

    

    

		string date(
[int
$timestamp = null])
    

    


	
		Locale date


    

  • Access: public
    • 








        
Parameters:

    

    

          

        int  
        $timestamp  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
dayName   [line 817]

	

    

    

		mixed dayName(
int
$weekday, [bool
$short = false])
    

    


	
		Day name


    

  • Return: Returns &type.string; name of weekday on success or                   <classname>PEAR_Error</classname> on failure.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        int  
        $weekday  
        —
          numerical representation of weekday                               (0 = Sunday, 1 = Monday, ...)
      

          

        bool  
        $short  
        —
          whether to return the abbreviation
      

        

    


        
[ Top ]

  

  
  
	
	
formatCurrency   [line 656]

	

    

    

		string formatCurrency(
numeric
$value, [int
$overrideFormat = null], [string
$overrideSymbol = null])
    

    


	
		Format currency


    

  • Access: public
    • 








        
Parameters:

    

    

          

        numeric  
        $value  
        —
          
      

          

        int  
        $overrideFormat  
        —
          
      

          

        string  
        $overrideSymbol  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
formatDate   [line 730]

	

    

    

		string formatDate(
[int
$timestamp = null], [int
$overrideFormat = null])
    

    


	
		Format a date


    

  • Access: public
    • 








        
Parameters:

    

    

          

        int  
        $timestamp  
        —
          
      

          

        int  
        $overrideFormat  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
formatDateTime   [line 766]

	

    

    

		string formatDateTime(
[int
$timestamp = null], [int
$overrideFormat = null])
    

    


	
		Format a datetime


    

  • Access: public
    • 








        
Parameters:

    

    

          

        int  
        $timestamp  
        —
          
      

          

        int  
        $overrideFormat  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
formatNumber   [line 714]

	

    

    

		string formatNumber(
numeric
$value, [int
$overrideFormat = null])
    

    


	
		Format a number


    

  • Access: public
    • 








        
Parameters:

    

    

          

        numeric  
        $value  
        —
          
      

          

        int  
        $overrideFormat  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
formatTime   [line 748]

	

    

    

		string formatTime(
[int
$timestamp = null], [int
$overrideFormat = null])
    

    


	
		Format a time


    

  • Access: public
    • 








        
Parameters:

    

    

          

        int  
        $timestamp  
        —
          
      

          

        int  
        $overrideFormat  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
initialize   [line 255]

	

    

    

		void initialize(
mixed
$locale)
    

    


	
		Initialize


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
loadCache   [line 442]

	

    

    

		bool loadCache(
string
$locale)
    

    


	
		Load Cache


    

  • Access: protected
    • 








        
Parameters:

    

    

          

        string  
        $locale  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
loadExtension   [line 459]

	

    

    

		void loadExtension(
)
    

    


	
		Loads corresponding locale extension


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
monthName   [line 842]

	

    

    

		mixed monthName(
int
$month, [bool
$short = false])
    

    


	
		Month name


    

  • Return: Returns &type.string; name of month on success or                   <classname>PEAR_Error</classname> on failure.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        int  
        $month  
        —
          numerical representation of month                           (0 = January, 1 = February, ...)
      

          

        bool  
        $short  
        —
          whether to return the abbreviation
      

        

    


        
[ Top ]

  

  
  
	
	
setCurrencyFormat   [line 510]

	

    

    

		mixed setCurrencyFormat(
int
$format, [bool
$custom = false])
    

    


	
		Set currency format


    

  • Return: Returns &true; on success or <classname>PEAR_Error</classname> on failure.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        int  
        $format  
        —
          a I18Nv2_CURRENCY constant
      

          

        bool  
        $custom  
        —
          whether to use a defined custom format
      

        

    


        
[ Top ]

  

  
  
	
	
setCustomFormat   [line 634]

	

    

    

		void setCustomFormat(
[mixed
$type = null], [mixed
$format = null])
    

    


	
		Set custom format
If $format is omitted, the custom format for $type  will be dsicarded - if both vars are omitted all custom formats will  be discarded.


    

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $type  
        —
          
      

          

        mixed  
        $format  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
setDateFormat   [line 558]

	

    

    

		mixed setDateFormat(
int
$format, [bool
$custom = false])
    

    


	
		Set date format


    

  • Return: Returns &true; on success or <classname>PEAR_Error</classname> on failure.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        int  
        $format  
        —
          a I18Nv2_DATETIME constant
      

          

        bool  
        $custom  
        —
          whether to use a defined custom format
      

        

    


        
[ Top ]

  

  
  
	
	
setDateTimeFormat   [line 606]

	

    

    

		mixed setDateTimeFormat(
int
$format, [bool
$custom = false])
    

    


	
		Set datetime format


    

  • Access: public
    • 








        
Parameters:

    

    

          

        int  
        $format  
        —
          a I18Nv2_DATETIME constant
      

          

        bool  
        $custom  
        —
          whether to use a defined custom format
      

        

    


        
[ Top ]

  

  
  
	
	
setDefaults   [line 478]

	

    

    

		void setDefaults(
)
    

    


	
		Set defaults


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
setLocale   [line 231]

	

    

    

		string setLocale(
string
$locale, [bool
$force = false])
    

    


	
		Set locale
This automatically calls I18Nv2_Locale::initialize()


    

  • Return: used system locale
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $locale  
        —
          
      

          

        bool  
        $force  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
setNumberFormat   [line 534]

	

    

    

		mixed setNumberFormat(
int
$format, [bool
$custom = false])
    

    


	
		Set number format


    

  • Return: Returns &true; on success or <classname>PEAR_Error</classname> on failure.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        int  
        $format  
        —
          a I18Nv2_NUMBER constant
      

          

        bool  
        $custom  
        —
          whether to use a defined custom format
      

        

    


        
[ Top ]

  

  
  
	
	
setParanoid   [line 496]

	

    

    

		void setParanoid(
[bool
$paranoid = false])
    

    


	
		Set Paranoid Mode
Whether to reset to the C-locale after every call.


    

  • Access: public
    • 








        
Parameters:

    

    

          

        bool  
        $paranoid  
        —
          Whether to enable paranoid mode.
      

        

    


        
[ Top ]

  

  
  
	
	
setTimeFormat   [line 582]

	

    

    

		mixed setTimeFormat(
int
$format, [bool
$custom = false])
    

    


	
		Set time format


    

  • Access: public
    • 








        
Parameters:

    

    

          

        int  
        $format  
        —
          a I18Nv2_DATETIME constant
      

          

        bool  
        $custom  
        —
          whether to use a defined custom format
      

        

    


        
[ Top ]

  

  
  
	
	
time   [line 784]

	

    

    

		string time(
[int
$timestamp = null])
    

    


	
		Locale time


    

  • Access: public
    • 








        
Parameters:

    

    

          

        int  
        $timestamp  
        —
          
      

        

    


        
[ Top ]

  

  
  
	
	
updateCache   [line 420]

	

    

    

		void updateCache(
string
$locale)
    

    


	
		Update Cache


    

  • Access: protected
    • 








        
Parameters:

    

    

          

        string  
        $locale  
        —
          
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Tue,  1 Mar 2005 10:34:17 -0500 by phpDocumentor 1.2.3. PEAR Logo Copyright ©  PHP Group 2004.