Реализация класса

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,63 @@
+# php-headers
+
+Компонент для работы с пользовательскими константами в PHP. Данный компонент помогает 
+оперировать константами и их представлениями.
+
+Например, в базу данных (БД) производится запись чего-го либо на английском языке. В то же
+время, пользователю отражается эта информация уже на русском языке.
+
+Данный класс предназначен для статической информации, которую нет смысла хранить в БД
+(как описано в примере выше).
+
+В пользовательских классах необходимо завести константы:
+
+```php
+CONST JUNIOR = 'junior';
+CONST MIDDLE = 'middle';
+CONST SENIOR = 'senior';
+```
+
+Далее составляется карта соответствия:
+
+```php
+protected static array $map = [
+    self::JUNIOR => 'Начинающий',
+    self::MIDDLE => 'Продвинутый',
+    self::SENIOR => 'Эксперт',
+];
+```
+
+Таким образом, можно обратиться как к самим константам класса (например, для сравнения), 
+так и к методам класса для получения информации о них.
+
+# Структура
+
+```
+src/
+--- interfaces/
+--- Entity.php
+```
+
+В директории `interfaces` хранятся необходимые интерфейсы, которые необходимо имплементировать в при реализации
+собственного класса `Entity`.
+
+Класс `Entity` реализует интерфейс `EntityInterface` для управления пользовательскими константами.
+
+# Доступные методы
+
+| Метод                         | Аргументы | Возвращаемые данные | Исключения               | Описание                                             |
+|-------------------------------|-----------|---------------------|--------------------------|------------------------------------------------------|
+| has(string $key)              | Ключ      | bool                |                          | Проверяет наличие ключа в списке                     |
+| getMap(string $key = '')      | Ключ      | array               | InvalidArgumentException | Возвращает список или массив [key => value] по ключу |
+| getMapValueByKey(string $key) | Ключ      | mixed               | InvalidArgumentException | Возвращает значение из списка по ключу               |
+| getConstants()                |           | array               |                          | Возвращает список всех констант класса               |
+
+# Контакты
+
+Вы можете связаться со мной в социальной сети ВКонтакте: [ВКонтакте: Максим Епихин](https://vk.com/maximepihin)
+
+Если удобно писать на почту, то можете воспользоваться этим адресом: mepihindeveloper@gmail.com
+
+Мой канал на YouTube, который посвящен разработке веб и игровых проектов: [YouTube: Максим Епихин](https://www.youtube.com/channel/UCKusRcoHUy6T4sei-rVzCqQ)
+
+Поддержать меня можно переводом на Яндекс.Деньги: [Денежный перевод](https://yoomoney.ru/to/410012382226565)

composer.json

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

interfaces/EntityInterface.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace mepihindeveloper\components\interfaces;
+
+use InvalidArgumentException;
+
+/**
+ * Интерфейс EntityInterface
+ *
+ * Декларирует методы обязательные для реализации компонента Entity
+ */
+interface EntityInterface {
+	
+	/**
+	 * Проверяет наличие ключа в списке
+	 *
+	 * @param string $key Ключ
+	 *
+	 * @return bool
+	 */
+	public static function has(string $key): bool;
+	
+	/**
+	 * Возвращает список или массив [key => value] по ключу
+	 *
+	 * @param string $key Ключ
+	 *
+	 * @return array
+	 *
+	 * @throws InvalidArgumentException
+	 */
+	public static function getMap(string $key = ''): array;
+	
+	/**
+	 * Возвращает значение из списка по ключу
+	 *
+	 * @param string $key Ключ
+	 *
+	 * @return mixed
+	 *
+	 * @throws InvalidArgumentException
+	 */
+	public static function getMapValueByKey(string $key);
+	
+	/**
+	 * Возвращает список всех констант класса
+	 *
+	 * @return array
+	 */
+	public static function getConstants(): array;
+}

src/Entity.php

@@ -0,0 +1,70 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace mepihindeveloper\components;
+
+use InvalidArgumentException;
+use mepihindeveloper\components\interfaces\EntityInterface;
+use ReflectionClass;
+
+/**
+ * Класс Entity
+ *
+ * Реализует управление списком констант
+ */
+class Entity implements EntityInterface {
+	
+	/**
+	 * @var array Список
+	 */
+	protected static array $map;
+	
+	/**
+	 * @inheritDoc
+	 */
+	public static function getConstants(): array {
+		$reflectionClass = new ReflectionClass(__CLASS__);
+		
+		return $reflectionClass->getConstants();
+	}
+	
+	/**
+	 * @inheritDoc
+	 */
+	public static function getMapValueByKey(string $key)
+	{
+		if (!self::has($key))
+		{
+			throw new InvalidArgumentException("Ключ {$key} отсутствует.");
+		}
+		
+		return self::$map[$key];
+	}
+	
+	/**
+	 * @inheritDoc
+	 */
+	public static function getMap(string $key = ''): array
+	{
+		if (empty($key))
+		{
+			return self::$map;
+		}
+		
+		if (!self::has($key))
+		{
+			throw new InvalidArgumentException("Ключ {$key} отсутствует.");
+		}
+		
+		return [$key => self::$map[$key]];
+	}
+	
+	/**
+	 * @inheritDoc
+	 */
+	public static function has(string $key): bool
+	{
+		return array_key_exists($key, self::$map);
+	}
+}