Helper class for char handling. More...

Public Member Functions
	__construct (string $char)
	isLetter ()
	isDigit ()
	isSpace ()
	isMark ()
	isControl ()
	isPrintable ()
	isNull ()
	isUpper ()
	isLower ()
	toUpper ()
	toLower ()
	toAscii ()
	toUnicode ()
	toHex ()
	toString ()
	toInt ()
	__toString ()

Static Public Member Functions
static	fromHex (string $hex)

Protected Attributes
string	$char

Detailed Description

Helper class for char handling.

Definition at line 13 of file Char.php.

Constructor & Destructor Documentation

◆ __construct()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Char::__construct ( string $char )

Char constructor.

Parameters

string $char

Exceptions

HelperException

Definition at line 28 of file Char.php.

Member Function Documentation

◆ __toString()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Char::__toString ( )

Returns the character as a standard string.

Returns: string

Definition at line 234 of file Char.php.

◆ fromHex()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Char::fromHex ( string $hex )

static

Returns the PlanetTeamSpeak\TeamSpeak3Framework\Helper\Char based on a given hex value.

Parameters

string $hex

Returns: Char

Exceptions

HelperException

Definition at line 200 of file Char.php.

◆ isControl()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Char::isControl ( )

Returns true if the character is a control character (i.e. "\t").

Returns: boolean

Definition at line 82 of file Char.php.

◆ isDigit()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Char::isDigit ( )

Returns true if the character is a decimal digit.

Returns: boolean

Definition at line 52 of file Char.php.

◆ isLetter()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Char::isLetter ( )

Returns true if the character is a letter.

Returns: boolean

Definition at line 42 of file Char.php.

◆ isLower()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Char::isLower ( )

Returns true if the character is a lowercase letter.

Returns: boolean

Definition at line 122 of file Char.php.

◆ isMark()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Char::isMark ( )

Returns true if the character is a mark.

Returns: boolean

Definition at line 72 of file Char.php.

◆ isNull()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Char::isNull ( )

Returns true if the character is the Unicode character 0x0000 ("\0").

Returns: boolean

Definition at line 102 of file Char.php.

◆ isPrintable()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Char::isPrintable ( )

Returns true if the character is a printable character.

Returns: boolean

Definition at line 92 of file Char.php.

◆ isSpace()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Char::isSpace ( )

Returns true if the character is a space.

Returns: boolean

Definition at line 62 of file Char.php.

◆ isUpper()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Char::isUpper ( )

Returns true if the character is an uppercase letter.

Returns: boolean

Definition at line 112 of file Char.php.

◆ toAscii()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Char::toAscii ( )

Returns the ascii value of the character.

Returns: integer

Definition at line 154 of file Char.php.

◆ toHex()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Char::toHex ( )

Returns the hexadecimal value of the char.

Returns: string

Definition at line 188 of file Char.php.

◆ toInt()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Char::toInt ( )

Returns the integer value of the character.

Returns: integer

Definition at line 224 of file Char.php.

◆ toLower()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Char::toLower ( )

Returns the lowercase equivalent if the character is uppercase.

Returns: Char

Exceptions

HelperException

Definition at line 144 of file Char.php.

◆ toString()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Char::toString ( )

Returns the character as a standard string.

Returns: string

Definition at line 214 of file Char.php.

◆ toUnicode()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Char::toUnicode ( )

Returns the Unicode value of the character.

Returns: integer

Definition at line 164 of file Char.php.

◆ toUpper()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Char::toUpper ( )

Returns the uppercase equivalent if the character is lowercase.

Returns: Char

Exceptions

HelperException

Definition at line 133 of file Char.php.

Member Data Documentation

◆ $char

string PlanetTeamSpeak\TeamSpeak3Framework\Helper\Char::$char

protected

Definition at line 20 of file Char.php.

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

src/Helper/Char.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ fromHex()

◆ isControl()

◆ isDigit()

◆ isLetter()

◆ isLower()

◆ isMark()

◆ isNull()

◆ isPrintable()

◆ isSpace()

◆ isUpper()

◆ toAscii()

◆ toHex()

◆ toInt()

◆ toLower()

◆ toString()

◆ toUnicode()

◆ toUpper()

Member Data Documentation

◆ $char