Wikimedia\Equivset\EquivsetInterface Interface Reference

Equivset. More...

Inheritance diagram for Wikimedia\Equivset\EquivsetInterface:

Public Member Functions
	all ()
	Gets the equivset.
	normalize (string $value)
	Normalize a string.
	isEqual (string $str1, string $str2)
	Determine if the two strings are visually equal.
	has (string $key)
	Determine if an equivalent character exists.
	get (string $key)
	Get an equivalent character.

Detailed Description

Equivset.

Member Function Documentation

all()

Wikimedia\Equivset\EquivsetInterface::all

(

)

Gets the equivset.

Returns

array An associative array of equivalent characters.

Implemented in Wikimedia\Equivset\Equivset.

get()

Wikimedia\Equivset\EquivsetInterface::get

(

string

$key

)

Get an equivalent character.

Parameters

string

$key

The character that was used.

Returns

string The equivalent character.

Exceptions

LogicException

If character does not exist.

Implemented in Wikimedia\Equivset\Equivset.

has()

Wikimedia\Equivset\EquivsetInterface::has

(

string

$key

)

Determine if an equivalent character exists.

Parameters

string

$key

The character that was used.

Returns

bool If the character has an equivalent.

Implemented in Wikimedia\Equivset\Equivset.

isEqual()

Wikimedia\Equivset\EquivsetInterface::isEqual	(	string	$str1,
		string	$str2 )

Determine if the two strings are visually equal.

Parameters

string	$str1	The first string.
string	$str2	The second string.

Returns

bool

Implemented in Wikimedia\Equivset\Equivset.

normalize()

Wikimedia\Equivset\EquivsetInterface::normalize

(

string

$value

)

Normalize a string.

Parameters

string

$value

The string to normalize against the equivset.

Returns

string

Implemented in Wikimedia\Equivset\Equivset.

---

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

• src/EquivsetInterface.php