TeamSpeak3_Helper_Char Class Reference

Helper class for char handling. More...

Public Member Functions
	__construct ($char)
	The TeamSpeak3_Helper_Char constructor. More...
	__toString ()
	Returns the character as a standard string. More...
	isControl ()
	Returns true if the character is a control character (i.e. More...
	isDigit ()
	Returns true if the character is a decimal digit. More...
	isLetter ()
	Returns true if the character is a letter. More...
	isLower ()
	Returns true if the character is a lowercase letter. More...
	isMark ()
	Returns true if the character is a mark. More...
	isNull ()
	Returns true if the character is the Unicode character 0x0000 ("\0"). More...
	isPrintable ()
	Returns true if the character is a printable character. More...
	isSpace ()
	Returns true if the character is a space. More...
	isUpper ()
	Returns true if the character is an uppercase letter. More...
	toAscii ()
	Returns the ascii value of the character. More...
	toHex ()
	Returns the hexadecimal value of the char. More...
	toInt ()
	Returns the integer value of the character. More...
	toLower ()
	Returns the lowercase equivalent if the character is uppercase. More...
	toString ()
	Returns the character as a standard string. More...
	toUnicode ()
	Returns the Unicode value of the character. More...
	toUpper ()
	Returns the uppercase equivalent if the character is lowercase. More...

Static Public Member Functions
static	fromHex ($hex)
	Returns the TeamSpeak3_Helper_Char based on a given hex value. More...

Detailed Description

Helper class for char handling.

Constructor & Destructor Documentation

__construct()

__construct

(

$char

)

The TeamSpeak3_Helper_Char constructor.

Parameters

string

$var

Exceptions

TeamSpeak3_Helper_Exception

Returns

TeamSpeak3_Helper_Char

 {
 if(strlen($char) != 1)
 {
 throw new TeamSpeak3_Helper_Exception("char parameter may not contain more or less than one character");
 }

 $this->char = strval($char);
 }

Member Function Documentation

__toString()

__toString

(

)

Returns the character as a standard string.

Returns

string

 {
 return $this->char;
 }

fromHex()

static fromHex (   $hex )

static

Returns the TeamSpeak3_Helper_Char based on a given hex value.

Parameters

string

$hex

Exceptions

TeamSpeak3_Helper_Exception

Returns

TeamSpeak3_Helper_Char

 {
 if(strlen($hex) != 2)
 {
 throw new TeamSpeak3_Helper_Exception("given parameter '" . $hex . "' is not a valid hexadecimal number");
 }

 return new self(chr(hexdec($hex)));
 }

isControl()

isControl

(

)

Returns true if the character is a control character (i.e.

"\t").

Returns

boolean

 {
 return ctype_cntrl($this->char);
 }

isDigit()

isDigit

(

)

Returns true if the character is a decimal digit.

Returns

boolean

 {
 return ctype_digit($this->char);
 }

isLetter()

isLetter

(

)

Returns true if the character is a letter.

Returns

boolean

 {
 return ctype_alpha($this->char);
 }

isLower()

isLower

(

)

Returns true if the character is a lowercase letter.

Returns

boolean

 {
 return ($this->char === strtolower($this->char)) ? TRUE : FALSE;
 }

isMark()

isMark

(

)

Returns true if the character is a mark.

Returns

boolean

 {
 return ctype_punct($this->char);
 }

isNull()

isNull

(

)

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

Returns

boolean

 {
 return ($this->char === "\0") ? TRUE : FALSE;
 }

isPrintable()

isPrintable

(

)

Returns true if the character is a printable character.

Returns

boolean

 {
 return ctype_print($this->char);
 }

isSpace()

isSpace

(

)

Returns true if the character is a space.

Returns

boolean

 {
 return ctype_space($this->char);
 }

isUpper()

isUpper

(

)

Returns true if the character is an uppercase letter.

Returns

boolean

 {
 return ($this->char === strtoupper($this->char)) ? TRUE : FALSE;
 }

toAscii()

toAscii

(

)

Returns the ascii value of the character.

Returns

integer

 {
 return ord($this->char);
 }

toHex()

toHex

(

)

Returns the hexadecimal value of the char.

Returns

string

 {
 return strtoupper(dechex($this->toAscii()));
 }

toInt()

toInt

(

)

Returns the integer value of the character.

Returns

integer

 {
 return intval($this->char);
 }

toLower()

toLower

(

)

Returns the lowercase equivalent if the character is uppercase.

Returns

TeamSpeak3_Helper_Char

 {
 return ($this->isLower()) ? $this : new self(strtolower($this));
 }

toString()

toString

(

)

Returns the character as a standard string.

Returns

string

 {
 return $this->char;
 }

toUnicode()

toUnicode

(

)

Returns the Unicode value of the character.

Returns

integer

 {
 $h = ord($this->char{0});

 if($h <= 0x7F)
 {
 return $h;
 }
 else if($h < 0xC2)
 {
 return FALSE;
 }
 else if($h <= 0xDF)
 {
 return ($h & 0x1F) << 6 | (ord($this->char{1}) & 0x3F);
 }
 else if($h <= 0xEF)
 {
 return ($h & 0x0F) << 12 | (ord($this->char{1}) & 0x3F) << 6 | (ord($this->char{2}) & 0x3F);
 }
 else if($h <= 0xF4)
 {
 return ($h & 0x0F) << 18 | (ord($this->char{1}) & 0x3F) << 12 | (ord($this->char{2}) & 0x3F) << 6 | (ord($this->char{3}) & 0x3F);
 }
 else
 {
 return FALSE;
 }
 }

toUpper()

toUpper

(

)

Returns the uppercase equivalent if the character is lowercase.

Returns

TeamSpeak3_Helper_Char

 {
 return ($this->isUpper()) ? $this : new self(strtoupper($this));
 }

---

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

• /Volumes/home/Repositories/planetteamspeak/ts3phpframework/libraries/TeamSpeak3/Helper/Char.php