MediaWiki master
Wikimedia\ReplacementArray Class Reference

Wrapper around strtr() that holds replacements. More...

Public Member Functions

 __construct (array $data=[])
 Create an object with the specified replacement array The array should have the same form as the replacement array for strtr()
 
 __sleep ()
 
 getArray ()
 
 merge (ReplacementArray $other)
 
 mergeArray ( $data)
 
 removeArray ( $data)
 
 removePair ( $from)
 
 replace ( $subject)
 
 setArray (array $data)
 Set the whole replacement array at once.
 
 setPair ( $from, $to)
 Set an element of the replacement array.
 

Detailed Description

Wrapper around strtr() that holds replacements.

Definition at line 12 of file ReplacementArray.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\ReplacementArray::__construct ( array $data = [])

Create an object with the specified replacement array The array should have the same form as the replacement array for strtr()

Parameters
array$data

Definition at line 20 of file ReplacementArray.php.

Member Function Documentation

◆ __sleep()

Wikimedia\ReplacementArray::__sleep ( )
Returns
array

Definition at line 27 of file ReplacementArray.php.

◆ getArray()

Wikimedia\ReplacementArray::getArray ( )
Returns
array

Definition at line 41 of file ReplacementArray.php.

◆ merge()

Wikimedia\ReplacementArray::merge ( ReplacementArray $other)

Definition at line 61 of file ReplacementArray.php.

◆ mergeArray()

Wikimedia\ReplacementArray::mergeArray ( $data)
Parameters
array$data

Definition at line 57 of file ReplacementArray.php.

◆ removeArray()

Wikimedia\ReplacementArray::removeArray ( $data)
Parameters
array$data

Definition at line 75 of file ReplacementArray.php.

◆ removePair()

Wikimedia\ReplacementArray::removePair ( $from)
Parameters
string$from

Definition at line 68 of file ReplacementArray.php.

◆ replace()

Wikimedia\ReplacementArray::replace ( $subject)
Parameters
string$subject
Returns
string

Definition at line 85 of file ReplacementArray.php.

◆ setArray()

Wikimedia\ReplacementArray::setArray ( array $data)

Set the whole replacement array at once.

Definition at line 34 of file ReplacementArray.php.

◆ setPair()

Wikimedia\ReplacementArray::setPair ( $from,
$to )

Set an element of the replacement array.

Parameters
string$from
string$to

Definition at line 50 of file ReplacementArray.php.


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