TeamSpeak3_Exception Class Reference

Enhanced exception class for TeamSpeak3 objects. More...

Inheritance diagram for TeamSpeak3_Exception:

Public Member Functions
	__construct ($mesg, $code=0x00)
	The TeamSpeak3_Exception constructor. More...
	getSender ()
	Returns the class from which the exception was thrown. More...

Static Public Member Functions
static	registerCustomMessage ($code, $mesg)
	Registers a custom error message to $code. More...
static	unregisterCustomMessage ($code)
	Unregisters a custom error message from $code. More...

Protected Member Functions
	prepareCustomMessage (TeamSpeak3_Helper_String $mesg)
	Prepares a custom error message by replacing pre-defined signs with given values. More...

Detailed Description

Enhanced exception class for TeamSpeak3 objects.

Constructor & Destructor Documentation

__construct()

__construct	(		$mesg,
			$code = 0x00
	)

The TeamSpeak3_Exception constructor.

Parameters

string	$mesg
integer	$code

Returns

TeamSpeak3_Exception

  {
    parent::__construct($mesg, $code);

    if(array_key_exists((int) $code, self::$messages))
    {
      $this->message = $this->prepareCustomMessage(self::$messages[intval($code)]);
    }

    TeamSpeak3_Helper_Signal::getInstance()->emit("errorException", $this);
  }

Member Function Documentation

getSender()

getSender

(

)

Returns the class from which the exception was thrown.

Returns

string

  {
    $trace = $this->getTrace();

    return (isset($trace[0]["class"])) ? $trace[0]["class"] : "{main}";
  }

prepareCustomMessage()

prepareCustomMessage ( TeamSpeak3_Helper_String  $mesg )

protected

Prepares a custom error message by replacing pre-defined signs with given values.

Parameters

TeamSpeak3_Helper_String

$mesg

Returns

TeamSpeak3_Helper_String

  {
    $args = array(
      "code" => $this->getCode(),
      "mesg" => $this->getMessage(),
      "line" => $this->getLine(),
      "file" => $this->getFile(),
    );

    return $mesg->arg($args)->toString();
  }

registerCustomMessage()

static registerCustomMessage (   $code,   $mesg  )

static

Registers a custom error message to $code.

Parameters

integer	$code
string	$mesg

Exceptions

TeamSpeak3_Exception

Returns

void

  {
    if(array_key_exists((int) $code, self::$messages))
    {
      throw new self("custom message for code 0x" . strtoupper(dechex($code)) . " is already registered");
    }

    if(!is_string($mesg))
    {
      throw new self("custom message for code 0x" . strtoupper(dechex($code)) . " must be a string");
    }

    self::$messages[(int) $code] = new TeamSpeak3_Helper_String($mesg);
  }

unregisterCustomMessage()

static unregisterCustomMessage (   $code )

static

Unregisters a custom error message from $code.

Parameters

integer

$code

Exceptions

TeamSpeak3_Exception

Returns

void

  {
    if(!array_key_exists((int) $code, self::$messages))
    {
      throw new self("custom message for code 0x" . strtoupper(dechex($code)) . " is not registered");
    }

    unset(self::$messages[(int) $code]);
  }

---

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

• /Volumes/home/Repositories/planetteamspeak/ts3phpframework/libraries/TeamSpeak3/Exception.php