Homework

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 4
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

.gitignore

@@ -1 +1,4 @@
 .idea
+application.log
+/vendor/
+composer.lock

Logger.php

@@ -1,23 +1,39 @@
 <?php
 
+declare(strict_types=1);
+
+require 'vendor/autoload.php';
+
+use Homework\Logger\AbstractHandler;
+use Homework\Logger\HandlerFactory;
+use Homework\Logger\Type;
 
 class Logger
 {
-    public static function get()
-    {
-        return new Logger();
-    }
+    private static $instance = null;
 
-    public function logError($message)
+    public static function get(): AbstractHandler
     {
-        $logFile = fopen('application.log', 'w');
-        fwrite($logFile, 'ERROR: ' . $message);
-        fclose($logFile);
+        if (self::$instance == null) {
+            self::$instance = HandlerFactory::get(self::getHandlerType());
+        }
+
+        return self::$instance;
     }
 
-    public function logSuccess($msg)
+    /**
+     * Get handler type.
+     *
+     * @return Type
+     */
+    private static function getHandlerType(): Type
     {
-        $logFile = fopen('application.log', 'a');
-        fwrite($logFile, 'SUCCESS: ' . $msg);
+        if (count($_SERVER['argv']) > 1) {
+            if ($_SERVER['argv'][1] === '-c' || $_SERVER['argv'][1] === '--console') {
+                return Type::CONSOLE;
+            }
+        }
+
+        return Type::FILE;
     }
-}
+}

Logger/AbstractHandler.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Homework\Logger;
+
+/**
+ * Abstract class for handlers.
+ */
+abstract class AbstractHandler
+{
+    /**
+     * Add error entity to log.
+     *
+     * @param string $message
+     *
+     * @return boolean
+     */
+    public function logError(string $message): bool
+    {
+        return $this->log(Status::ERROR, $message);
+    }
+
+    /**
+     * Add success entity to log.
+     *
+     * @param string $message
+     *
+     * @return boolean
+     */
+    public function logSuccess(string $message): bool
+    {
+        return $this->log(Status::SUCCESS, $message);
+    }
+}

Logger/ConsoleHandler.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Homework\Logger;
+
+/**
+ * Console logger handler.
+ */
+class ConsoleHandler extends AbstractHandler implements HandlerInterface
+{
+    use ValidationTrait;
+
+    /**
+     * Add log entity to console.
+     *
+     * @param Status $type
+     * @param string $message
+     *
+     * @return boolean
+     */
+    public function log(Status $type, string $message): bool
+    {
+        if (!$this->validate($message)) {
+            return false;
+        }
+
+        $file = fopen('php://stdout', 'a');
+
+        fwrite($file, sprintf("%s: %s\n", $type->getLabel(), $message));
+
+        return fclose($file);
+    }
+}

Logger/FileHandler.php

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Homework\Logger;
+
+use Exception;
+
+/**
+ * File logger handler.
+ */
+class FileHandler extends AbstractHandler implements HandlerInterface
+{
+    use ValidationTrait;
+
+    public function __construct(private string $LOG_FILE = __DIR__ . '/../application.log')
+    {
+    }
+
+    /**
+     * Add log entity to file.
+     *
+     * @param Status $type
+     * @param string $message
+     *
+     * @return boolean
+     */
+    public function log(Status $type, string $message): bool
+    {
+        if (!$this->createFile()) {
+            return false;
+        }
+
+        if (!$this->validate($message)) {
+            return false;
+        }
+
+        $file = fopen($this->LOG_FILE, 'a');
+
+        fwrite($file, sprintf("%s: %s\n", $type->getLabel(), $message));
+
+        return fclose($file);
+    }
+
+    /**
+     * Check if file exists or not.
+     *
+     * @return boolean
+     */
+    private function fileExists(): bool
+    {
+        return file_exists($this->LOG_FILE) && is_file($this->LOG_FILE) && is_writable($this->LOG_FILE);
+    }
+
+    /**
+     * Create file if not exists.
+     *
+     * @return boolean
+     */
+    private function createFile(): bool
+    {
+        if (!$this->fileExists() && !fopen($this->LOG_FILE, 'c')) {
+            throw new Exception('Cannot create file');
+        }
+
+        return $this->fileExists();
+    }
+}

Logger/HandlerFactory.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Homework\Logger;
+
+/**
+ * Handler factory.
+ */
+class HandlerFactory
+{
+    /**
+     * Get handler instance.
+     *
+     * @param Type $type
+     *
+     * @return AbstractHandler
+     */
+    public static function get(Type $type = Type::FILE): AbstractHandler
+    {
+        return match ($type) {
+            Type::FILE => new FileHandler(),
+            Type::CONSOLE => new ConsoleHandler()
+        };
+    }
+}

Logger/HandlerInterface.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Homework\Logger;
+
+/**
+ * Interface for handlers.
+ */
+interface HandlerInterface
+{
+    /**
+     * Add entity to log.
+     *
+     * @param Status $type
+     * @param string $message
+     *
+     * @return boolean
+     */
+    public function log(Status $type, string $message): bool;
+}

Logger/Status.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Homework\Logger;
+
+/**
+ * Log entity status.
+ */
+enum Status
+{
+    case ERROR;
+    case SUCCESS;
+
+    /**
+     * Get text label for status.
+     *
+     * @return string
+     */
+    public function getLabel(): string
+    {
+        return match ($this) {
+            Status::ERROR => 'Error',
+            Status::SUCCESS => 'Success'
+        };
+    }
+}

Logger/Type.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Homework\Logger;
+
+/**
+ * Handler types.
+ */
+enum Type
+{
+    case FILE;
+    case CONSOLE;
+}

Logger/ValidationTrait.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Homework\Logger;
+
+/**
+ * Validation trait
+ */
+trait ValidationTrait
+{
+    /**
+     * Validate log message.
+     *
+     * @param string $message
+     *
+     * @return boolean
+     */
+    public function validate(string $message): bool
+    {
+        if (!is_string($message)) {
+            return false;
+        }
+
+        if (mb_check_encoding($message, 'UTF-8') !== true) {
+            return false;
+        }
+
+        if (trim($message) === '') {
+            return false;
+        }
+
+        return true;
+    }
+}

composer.json

@@ -0,0 +1,22 @@
+{
+    "name": "catsand/homework",
+    "description": "Test task for Mobily",
+    "type": "project",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "catsAND",
+            "email": "[email protected]"
+        }
+    ],
+    "autoload": {
+        "psr-4": {"Homework\\": "./"}
+    },
+    "require": {
+        "php": "^8.1",
+        "ext-mbstring": "*"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^9.5"
+    }
+}

index.php

@@ -3,6 +3,9 @@
 require_once 'Logger.php';
 
 
+// Do not change this file
+
+
 function process()
 {
     for ($i = 0; $i < 3; $i++) {