StringMangler Interface Reference

Interface that key-mangling classes must implement. More...

Inheritance diagram for StringMangler:

[legend]

List of all members.

Public Member Functions
	setConf ($configuration)
	General way to pass configuration to the mangler.
	match ($string)
	Match strings against a pattern.
	mangle ($data)
	Mangles a list of message keys.
	unMangle ($data)
	Reverses the operation mangle() did.
Static Public Member Functions
static	EmptyMatcher ()

---

Detailed Description

Interface that key-mangling classes must implement.

The operations have to be reversible so that x equals unMangle( mangle( x ) ).

Definition at line 16 of file StringMatcher.php.

---

Member Function Documentation

static StringMangler::EmptyMatcher

(

)

[static]

Todo:

Does this really need to be in the interface???

Implemented in StringMatcher.

StringMangler::mangle

(

$

data

)

Mangles a list of message keys.

Parameters:

string|string[]

$data Unmangled message keys.

Returns:

string|string[] Mangled message keys.

Implemented in StringMatcher.

Referenced by WikiFormatReader::parseMessages().

StringMangler::match

(

$

string

)

Match strings against a pattern.

If string matches, mangle() should mangle the key.

Parameters:

string

$string Message key.

Returns:

  Boolean  

Implemented in StringMatcher.

StringMangler::setConf

(

$

configuration

)

General way to pass configuration to the mangler.

Parameters:

array

$configuration

Implemented in StringMatcher.

StringMangler::unMangle

(

$

data

)

Reverses the operation mangle() did.

Parameters:

string|string[]

$data Mangled message keys.

Returns:

string|string[] Umangled message keys.

Implemented in StringMatcher.

---

The documentation for this interface was generated from the following file:

• Translate/utils/StringMatcher.php