Initial commit

2016-06-28 23:18:59 +02:00
parent e321e10551
commit e49c2c27ad
390 changed files with 22561 additions and 0 deletions
--- a/lib/ts3phpframework/libraries/TeamSpeak3/Exception.php
+++ b/lib/ts3phpframework/libraries/TeamSpeak3/Exception.php
@ -0,0 +1,129 @@
+<?php
+
+/**
+ * @file
+ * TeamSpeak 3 PHP Framework
+ *
+ * $Id: Exception.php 06/06/2016 22:27:13 scp@Svens-iMac $
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @package   TeamSpeak3
+ * @version   1.1.24
+ * @author    Sven 'ScP' Paulsen
+ * @copyright Copyright (c) 2010 by Planet TeamSpeak. All rights reserved.
+ */
+
+/**
+ * @class TeamSpeak3_Exception
+ * @brief Enhanced exception class for TeamSpeak3 objects.
+ */
+class TeamSpeak3_Exception extends Exception
+{
+  /**
+   * Stores custom error messages.
+   *
+   * @var array
+   */
+  protected static $messages = array();
+
+  /**
+   * The TeamSpeak3_Exception constructor.
+   *
+   * @param  string  $mesg
+   * @param  integer $code
+   * @return TeamSpeak3_Exception
+   */
+  public function __construct($mesg, $code = 0x00)
+  {
+    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);
+  }
+
+  /**
+   * Prepares a custom error message by replacing pre-defined signs with given values.
+   *
+   * @param  TeamSpeak3_Helper_String $mesg
+   * @return TeamSpeak3_Helper_String
+   */
+  protected function prepareCustomMessage(TeamSpeak3_Helper_String $mesg)
+  {
+    $args = array(
+      "code" => $this->getCode(),
+      "mesg" => $this->getMessage(),
+      "line" => $this->getLine(),
+      "file" => $this->getFile(),
+    );
+
+    return $mesg->arg($args)->toString();
+  }
+
+  /**
+   * Registers a custom error message to $code.
+   *
+   * @param  integer $code
+   * @param  string  $mesg
+   * @throws TeamSpeak3_Exception
+   * @return void
+   */
+  public static function registerCustomMessage($code, $mesg)
+  {
+    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);
+  }
+
+  /**
+   * Unregisters a custom error message from $code.
+   *
+   * @param  integer $code
+   * @throws TeamSpeak3_Exception
+   * @return void
+   */
+  public static function unregisterCustomMessage($code)
+  {
+    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]);
+  }
+
+  /**
+   * Returns the class from which the exception was thrown.
+   *
+   * @return string
+   */
+  public function getSender()
+  {
+    $trace = $this->getTrace();
+
+    return (isset($trace[0]["class"])) ? $trace[0]["class"] : "{main}";
+  }
+}