refactoring

blacknell · Jan 9, 2019 · a83b0d9 · a83b0d9
1 parent 1e416a3
commit a83b0d9
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 9 deletions.
diff --git a/example/MyAPI.class.php b/example/MyAPI.class.php
@@ -91,13 +91,13 @@ protected function daylight()
 
 			}
 			catch (OutOfBoundsException $e) {
-				$this->logger->error($e->getMessage(), $this->toString());
+				$this->logger->error($e->getMessage(), $this->toObject());
 				$this->logger->error($e->getTraceAsString());
 
 				return array("result" => ['error' => $e->getMessage(), 'code' => $e->getCode()], "code" => $e->getCode());
 			}
 			catch (Exception $e) {
-				$this->logger->error($e->getMessage(), $this->toString());
+				$this->logger->error($e->getMessage(), $this->toObject());
 				$this->logger->error($e->getTraceAsString());
 
 				return array("result" => ['error' => $e->getMessage(), 'code' => 400], "code" => 400);

diff --git a/src/RestAPI.php b/src/RestAPI.php
@@ -54,7 +54,7 @@ abstract class RestAPI
 	 * API constructor.
 	 *
 	 * @param             $request
-	 * @param Logger|null $logger created via Monolog\Monolog
+	 * @param \Monolog\Logger|null $logger created via Monolog\Monolog
 	 *
 	 * @throws RuntimeException
 	 */
@@ -103,16 +103,18 @@ public function __construct($request, \Monolog\Logger $logger = null)
 				$this->file = file_get_contents("php://input");
 				break;
 			default:
-				$this->logger->error("Method Not Allowed", $this->toString());
+				$this->logger->error("Method Not Allowed", $this->toObject());
 				throw new RuntimeException("Method Not Allowed", 405);
 				break;
 		}
 	}
 
 	/**
+	 * Returns the request components as an object
+	 * 
 	 * @return array
 	 */
-	protected function toString()
+	protected function toObject()
 	{
 		return [
 			'method'=> $this->method,
@@ -129,11 +131,11 @@ public function processAPI()
 	{
 		if ((int) method_exists($this, $this->endpoint) > 0) {
 			$result = $this->{$this->endpoint}($this->args);
-			$this->logger->debug("API processed", array($this->toString(), $result));
+			$this->logger->debug("API processed", array($this->toObject(), $result));
 
 			return $this->response($result['result'], $result['code']);
 		}
-		$this->logger->error("No endpoint: $this->endpoint", $this->toString());
+		$this->logger->error("No endpoint: $this->endpoint", $this->toObject());
 
 		return $this->response(['error' => "No endpoint", 'code' => 404], 404);
 	}

diff --git a/tests/StubAPI.php b/tests/StubAPI.php
@@ -26,13 +26,13 @@ protected function stubGet()
 
 			}
 			catch (OutOfBoundsException $e) {
-				$this->logger->error($e->getMessage(), $this->toString());
+				$this->logger->error($e->getMessage(), $this->toObject());
 				$this->logger->error($e->getTraceAsString());
 
 				return array("result" => ['error' => $e->getMessage(), 'code' => $e->getCode()], "code" => $e->getCode());
 			}
 			catch (Exception $e) {
-				$this->logger->error($e->getMessage(), $this->toString());
+				$this->logger->error($e->getMessage(), $this->toObject());
 				$this->logger->error($e->getTraceAsString());
 
 				return array("result" => ['error' => $e->getMessage(), 'code' => 400], "code" => 400);