Изменено описание проекта и методов

Author: mepihindeveloper

README.md

@@ -1,29 +1,30 @@
-# php-headers
+# php-configuration
 
-Компонент для работы с консолью
+Компонент для работы с конфигурацией (настройками) приложения, модулей и компонентов
 
 # Структура
 
 ```
 src/
 --- interfaces/
---- Console.php
+--- Configuration.php
 ```
 
 В директории `interfaces` хранятся необходимые интерфейсы, которые необходимо имплементировать в при реализации
-собственного класса `Console`.
+собственного класса `Configuration`.
 
-Класс `Console` реализует интерфейс `ConsoleInterface` для управления консолью.
+Класс `Configuration` реализует интерфейс `ConfigurationInterface` для управления конфигурацией (настройками)
+приложения, модулей и компонентов.
 
 # Доступные методы
 
-| Метод                                               | Аргументы                                               | Возвращаемые данные | Исключения | Описание                                   |
-|-----------------------------------------------------|---------------------------------------------------------|---------------------|------------|--------------------------------------------|
-| 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                |            | Выводит сообщение о подтверждении действия |
+| Метод                         | Аргументы                          | Возвращаемые данные | Исключения               | Описание                                                                                                                          |
+|-------------------------------|------------------------------------|---------------------|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
+| __construct(array $settings)  | $settings Массив настроек          |                     |                          | Конструктор                                                                                                                       |
+| getSettings(): array          |                                    | array               |                          | Возвращает массив настроек                                                                                                        |
+| setSettings(array $settings)  | $settings Настройки [key => value] | void                |                          | Устанавливает настройку                                                                                                           |
+| getSettingsByKey(string $key) | $key Ключ                          | mixed               | InvalidArgumentException | Возвращает настройки по ключу. Здесь могут быть как отдельные настройки, так и массив настроек (например, для какой-то категории) |
+| hasKey(string $key)           | $key Ключ                          | bool                |                          | Проверяет наличие ключа в настройках                                                                                              |
 
 # Контакты
 

src/Configuration.php

@@ -22,6 +22,11 @@ class Configuration implements ConfigurationInterface {
 	 */
 	protected array $settings;
 
+	/**
+	 * Configuration constructor.
+	 *
+	 * @param array $settings Массив настроек
+	 */
 	public function __construct(array $settings) {
 		$this->settings = $settings;
 	}