Interface for a class handling an IRC collation. More...

Inheritance diagram for Erebot\Interfaces\IrcCollator:

Detailed Description

Interface for a class handling an IRC collation.

An IRC collation is used to compare different IRC objets, eg. two IRC nicknames, in order to find out whether they refer to the same thing or not.

Definition at line 32 of file IrcCollator.php.

Member Function Documentation

Erebot\Interfaces\IrcCollator::compare	(	$a,
		$b
	)

Compares two string in a case-insensitive fashion (like strcasecmp).

Parameters

$a	First string to compare.
$b	Second string to compare.

Return values

int	An integer less than, equal to or greater than zero if $a is found, respectively, to be less than, to match, or be greater than $b.

Erebot\Interfaces\IrcCollator::limitedCompare	(	$a,
		$b,
		$len
	)

Compares two string in a case-insensitive fashion up to a given length (like strncasecmp).

Parameters

$a	First string to compare.
$b	Second string to compare.
$len	Limit the comparison to only the first $len bytes of each string.

Return values

int	An integer less than, equal to or greater than zero if the first $len bytes of $a are found, respectively, to be less than, to match, or be greater than the first $len bytes of $b.

Erebot\Interfaces\IrcCollator::normalizeNick ( $nick )

Normalize (canonicalize) some IRC nickname.

This method can be used to compare two IRC nicknames like this:

if ($conn->normalizeNick($nick1) == $conn->normalizeNick($nick2)) {
    // The two nicknames are considered equal.
}

Parameters

string $nick The nickname to canonicalize.

Return values

string A canonical representation of the nickname.

Warning: Make sure you use the same collation when comparing two nicknames or the result may be unpredictable.

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