#34 - allow custom data in log objects

technicalguru · Jul 14, 2021 · 7ee87a2 · 7ee87a2
1 parent b30903d
commit 7ee87a2
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 22 deletions.
diff --git a/src/TgLog/Debug.php b/src/TgLog/Debug.php
@@ -11,9 +11,10 @@ class Debug extends Message {
     /**
      * Constructs the debug.
      * @param string $message - the message text.
+     * @param mixed  $data    - custom additional data for application specific usage.
      */
-	public function __construct($message) {
-		parent::__construct('debug', $message);
+	public function __construct($message, $data = NULL) {
+		parent::__construct('debug', $message, $data);
 	}
 
-}
+}
diff --git a/src/TgLog/Error.php b/src/TgLog/Error.php
@@ -11,9 +11,10 @@ class Error extends Message {
     /**
      * Constructs the error.
      * @param string $message - the message text.
+     * @param mixed  $data    - custom additional data for application specific usage.
      */
-	public function __construct($message) {
-		parent::__construct('error', $message);
+	public function __construct($message, $data = NULL) {
+		parent::__construct('error', $message, $data);
 	}
 
-}
+}
diff --git a/src/TgLog/Info.php b/src/TgLog/Info.php
@@ -11,9 +11,10 @@ class Info extends Message {
     /**
      * Constructs the info.
      * @param string $message - the message text.
+     * @param mixed  $data    - custom additional data for application specific usage.
      */
-	public function __construct($message) {
-		parent::__construct('info', $message);
+	public function __construct($message, $data = NULL) {
+		parent::__construct('info', $message, $data);
 	}
 
-}
+}
diff --git a/src/TgLog/Log.php b/src/TgLog/Log.php
@@ -12,11 +12,12 @@
  */
 class Log {
 
-    public const NONE  = 'none';
-    public const DEBUG = 'debug';
-    public const INFO  = 'info';
-    public const WARN  = 'warn';
-    public const ERROR = 'error';
+    public const NONE    = 'none';
+    public const DEBUG   = 'debug';
+    public const INFO    = 'info';
+    public const WARN    = 'warn';
+    public const ERROR   = 'error';
+    public const SUCCESS = 'success';
 
     /** The available log priorities */
     protected static $logPriorities;

diff --git a/src/TgLog/Message.php b/src/TgLog/Message.php
@@ -10,10 +10,12 @@ class Message {
 
 	protected $type;
 	protected $message;
+	protected $data;
 
-	public function __construct($type, $message) {
+	public function __construct($type, $message, $data = NULL) {
 		$this->type	   = $type;
 		$this->message = $message;
+		$this->data    = $data;
 	}
 
 	/**
@@ -31,4 +33,21 @@ public function getType() {
 	public function getMessage() {
 		return $this->message;
 	}
-}
+
+	/**
+	 * Sets the custom additonal data
+	 * @param mixed $data - the data.
+	 */
+	public function setData($data) {
+		$this->data = $data;
+		return $this;
+	}
+
+	/**
+	 * Returns the custom additonal data
+	 * @return mixed the data.
+	 */
+	public function getData() {
+		return $this->data;
+	}
+}
diff --git a/src/TgLog/Success.php b/src/TgLog/Success.php
@@ -11,9 +11,10 @@ class Success extends Message {
     /**
      * Constructs the success message.
      * @param string $message - the message text.
+     * @param mixed  $data    - custom additional data for application specific usage.
      */
-    public function __construct($message) {
-		parent::__construct('success', $message);
+    public function __construct($message, $data = NULL) {
+		parent::__construct('success', $message, $data);
 	}
 
-}
+}
diff --git a/src/TgLog/Warning.php b/src/TgLog/Warning.php
@@ -11,9 +11,10 @@ class Warning extends Message {
     /**
      * Constructs the warning.
      * @param string $message - the message text.
+     * @param mixed  $data    - custom additional data for application specific usage.
      */
-	public function __construct($message) {
-		parent::__construct('warning', $message);
+	public function __construct($message, $data = NULL) {
+		parent::__construct('warning', $message, $data);
 	}
 
-}
+}