Реализация компонента

Author: mepihindeveloper

.gitignore

@@ -0,0 +1 @@
+/vendor/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Maxim N Epikhin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,37 @@
+# php-headers
+
+Компонент для работы с консолью
+
+# Структура
+
+```
+src/
+--- interfaces/
+--- Console.php
+```
+
+В директории `interfaces` хранятся необходимые интерфейсы, которые необходимо имплементировать в при реализации
+собственного класса `Console`.
+
+Класс `Console` реализует интерфейс `ConsoleInterface` для управления консолью.
+
+# Доступные методы
+
+| Метод                                               | Аргументы                                               | Возвращаемые данные | Исключения | Описание                                   |
+|-----------------------------------------------------|---------------------------------------------------------|---------------------|------------|--------------------------------------------|
+| static readLine()                                   |                                                         | string              |            | Получает (читает) введенную строку         |
+| static clearScreen()                                |                                                         | void                |            | Очищает экран консоли                      |
+| static write(string $text, int $color = 0)          | $text Строка для записи; $color Цвет шрифта            | void                |            | Записывает строку без переноса             |
+| static writeLine(string $text, int $color = 0)      | $text Строка для записи; $color Цвет шрифта            | void                |            | Записывает строку с переносом              |
+| static confirm(string $text, bool $default = false) | $text Сообщение вопроса; $default Значение по умолчанию | bool                |            | Выводит сообщение о подтверждении действия |
+
+# Контакты
+
+Вы можете связаться со мной в социальной сети ВКонтакте: [ВКонтакте: Максим Епихин](https://vk.com/maximepihin)
+
+Если удобно писать на почту, то можете воспользоваться этим адресом: [email protected]
+
+Мой канал на YouTube, который посвящен разработке веб и игровых
+проектов: [YouTube: Максим Епихин](https://www.youtube.com/channel/UCKusRcoHUy6T4sei-rVzCqQ)
+
+Поддержать меня можно переводом на Яндекс.Деньги: [Денежный перевод](https://yoomoney.ru/to/410012382226565)

composer.json

@@ -0,0 +1,28 @@
+{
+	"name": "mepihindeveloper/php-console",
+	"description": "Component for working with console",
+	"type": "library",
+	"license": "MIT",
+	"keywords": [
+		"component",
+		"class",
+		"php",
+		"console"
+	],
+	"authors": [
+		{
+			"name": "mepihindeveloper",
+			"email": "[email protected]"
+		}
+	],
+	"require": {
+		"php": ">=7.4"
+	},
+	"autoload": {
+		"psr-4": {
+			"mepihindeveloper\\components\\": "src/"
+		}
+	},
+	"minimum-stability": "dev",
+	"prefer-stable": true
+}

src/Console.php

@@ -0,0 +1,84 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace mepihindeveloper\components;
+
+use mepihindeveloper\components\interfaces\ConsoleInterface;
+
+/**
+ * Класс Console
+ *
+ * Класс реализует считываем и записью в консоль
+ *
+ * @package mepihindeveloper\components
+ */
+class Console implements ConsoleInterface {
+	
+	/**
+	 * Константы для определения цвета текста
+	 */
+	public const FG_WHITE = 0;
+	public const FG_RED = 31;
+	public const FG_GREEN = 32;
+	/**
+	 * Константы для определения толщины шрифта
+	 */
+	public const FONT_NORMAL = 0;
+	public const FONT_BOLD = 1;
+	
+	/**
+	 * @inheritDoc
+	 */
+	public static function clearScreen(): void {
+		echo "\033[2J";
+	}
+	
+	/**
+	 * @inheritDoc
+	 */
+	public static function writeLine(string $text, int $color = 0): void {
+		static::write($text . PHP_EOL, $color);
+	}
+	
+	/**
+	 * @inheritDoc
+	 */
+	public static function write(string $text, int $color = 0): void {
+		fwrite(STDOUT, "\033[0;{$color}m{$text}\033[0m");
+	}
+	
+	/**
+	 * Выводит сообщение о подтверждении действия
+	 *
+	 * @param string $text Сообщение вопроса
+	 * @param bool $default Значение по умолчанию
+	 *
+	 * @return bool
+	 */
+	public static function confirm(string $text, bool $default = false): bool {
+		while (true) {
+			static::write($text . ' (y|n) [' . ($default ? 'y' : 'n') . ']: ');
+			$input = strtolower(trim(static::readLine()));
+			
+			if (empty($input)) {
+				return $default;
+			}
+			
+			if (!strcasecmp($input, 'y')) {
+				return true;
+			}
+			
+			if (!strcasecmp($input, 'n')) {
+				return false;
+			}
+		}
+	}
+	
+	/**
+	 * @inheritDoc
+	 */
+	public static function readLine(): string {
+		return rtrim(fgets(STDIN), PHP_EOL);
+	}
+}

src/interfaces/ConsoleInterface.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace mepihindeveloper\components\interfaces;
+
+/**
+ * Interface ConsoleInterface
+ *
+ * Декларирует методы обязательные для реализации компонента Console
+ *
+ * @package mepihindeveloper\components\interfaces
+ */
+interface ConsoleInterface {
+	
+	/**
+	 * Получает (читает) введенную строку
+	 *
+	 * @return string
+	 */
+	public static function readLine(): string;
+	
+	/**
+	 * Очищает экран консоли
+	 */
+	public static function clearScreen(): void;
+	
+	/**
+	 * Записывает строку без переноса
+	 *
+	 * @param string $text Строка для записи
+	 * @param int $color Цвет шрифта
+	 */
+	public static function write(string $text, int $color = 0): void;
+	
+	/**
+	 * Записывает строку с переносом
+	 *
+	 * @param string $text Строка для записи
+	 * @param int $color Цвет шрифта
+	 */
+	public static function writeLine(string $text, int $color = 0): void;
+}