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

Class: Translation2_Decorator_CacheMemory

Source Location: /Translation2-2.0.4/Translation2/Decorator/CacheMemory.php

Class Overview

Translation2
   |
   --Translation2_Decorator
      |
      --Translation2_Decorator_CacheMemory

Decorator to cache fetched data in memory


Author(s):

Version:

  • CVS: $Id: CacheMemory.php 305985 2010-12-05 22:55:33Z clockwerx $

Copyright:

  • 2004-2007 Lorenzo Alberton

Variables

Methods


Inherited Variables

Inherited Methods

Class: Translation2_Decorator

Translation2_Decorator::Translation2_Decorator()
Constructor Constructs the Translation2_Decorator
Translation2_Decorator::get()
Get translated string
Translation2_Decorator::getDecorator()
Return an instance of a decorator
Translation2_Decorator::getLang()
Get language info
Translation2_Decorator::getLangs()
Get languages
Translation2_Decorator::getPage()
Same as getRawPage, but resort to fallback language and replace parameters when needed
Translation2_Decorator::getRaw()
Get translated string
Translation2_Decorator::getRawPage()
Get the array of strings in a page
Translation2_Decorator::getStringID()
Get the stringID for the given string. This method is the reverse of get().
Translation2_Decorator::replaceEmptyStringsWithKeys()
Replace empty strings with their stringID
Translation2_Decorator::setCharset()
Set charset used to read/store the translations
Translation2_Decorator::setContainerOptions()
Set some storage driver options
Translation2_Decorator::setLang()
Set default language
Translation2_Decorator::setOption()
set Decorator option
Translation2_Decorator::setOptions()
set Decorator options
Translation2_Decorator::setPageID()
Set default page
Translation2_Decorator::setParams()
Set parameters for next string
Translation2_Decorator::_replaceParams()
Replace parameters in strings
Translation2_Decorator::__clone()
Clone internal object references

Class: Translation2

Translation2::Translation2()
Constructor
Translation2::factory()
Return a Translation2 instance already initialized
Translation2::get()
Get translated string
Translation2::getDecorator()
Return an instance of a decorator
Translation2::getLang()
get lang info
Translation2::getLangs()
get langs
Translation2::getPage()
Get an entire group of strings
Translation2::getRaw()
Get translated string (as-is)
Translation2::getRawPage()
Get the array of strings in a page
Translation2::getStringID()
Get the stringID for the given string. This method is the reverse of get().
Translation2::replaceEmptyStringsWithKeys()
Replace empty strings with their stringID
Translation2::setCharset()
Set charset used to read/store the translations
Translation2::setContainerOptions()
Set some storage driver options
Translation2::setLang()
Set default lang
Translation2::setPageID()
Set default page
Translation2::setParams()
Set parameters for next string
Translation2::_replaceParams()
Replace parameters in strings
Translation2::__clone()
Clone internal object references

Class Details

[line 68]
Decorator to cache fetched data in memory


[ Top ]


Class Variables

$prefetch =  true

[line 86]

set prefetch on/off
  • Access: protected

Type:   boolean


[ Top ]

$rawData = array()

[line 79]

Translated strings array Used for cache purposes.

No parameter substitution or fallback langs here.

  • Access: protected

Type:   array


[ Top ]



Method Detail

get   [line 171]

string get( string $stringID, [string $pageID = TRANSLATION2_DEFAULT_PAGEID], [string $langID = null], [string $defaultText = null])

Get translated string

First check if the string is cached, if not => fetch the page from the container and cache it for later use.


Overrides Translation2_Decorator::get() (Get translated string)

Parameters:

string   $stringID     string ID
string   $pageID     page/group ID
string   $langID     language ID
string   $defaultText     Text to display when the strings in both the default and the fallback lang are empty

[ Top ]

getPage   [line 218]

array getPage( [string $pageID = TRANSLATION2_DEFAULT_PAGEID], [string $langID = null])

Same as getRawPage, but resort to fallback language and replace parameters when needed

Overrides Translation2_Decorator::getPage() (Same as getRawPage, but resort to fallback language and replace parameters when needed)

Parameters:

string   $pageID     page/group ID
string   $langID     language ID

[ Top ]

getRaw   [line 130]

string getRaw( string $stringID, [string $pageID = TRANSLATION2_DEFAULT_PAGEID], [string $langID = null], [string $defaultText = null])

Get translated string (as-is)

First check if the string is cached, if not => fetch the page from the container and cache it for later use.


Overrides Translation2_Decorator::getRaw() (Get translated string)

Parameters:

string   $stringID     string ID
string   $pageID     page/group ID
string   $langID     language ID
string   $defaultText     Text to display when the strings in both the default and the fallback lang are empty

[ Top ]

getRawPage   [line 191]

array getRawPage( [string $pageID = TRANSLATION2_DEFAULT_PAGEID], [string $langID = null])

Get the array of strings in a page

First check if the strings are cached, if not => fetch the page from the container and cache it for later use.


Overrides Translation2_Decorator::getRawPage() (Get the array of strings in a page)

Parameters:

string   $pageID     page/group ID
string   $langID     language ID

[ Top ]


Documentation generated on Mon, 06 Dec 2010 00:00:20 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.