Merge pull request #16 from SimpleREST/develop

Develop

Author: stdimensiy

src/Console/Base/Command.php

@@ -10,7 +10,7 @@
  * Класс:
  * - содержит реализации общих методов для всех команд;
  * - инициирует все свойства команд, общие для всех команд;
- * - имплементи́рует общий для всех интерфейс;
+ * - имплементируют общий для всех интерфейс;
  *
  */
 abstract class Command implements Commands

src/Console/Base/Input.php

@@ -62,7 +62,7 @@ public function hasCommands(): bool
     }
 
     /**
-     * Ирпизнак присутствия как минимум одной опции
+     * Признак присутствия как минимум одной опции
      * @return bool
      */
     public function hasOptions(): bool

src/Console/Base/Output.php

@@ -68,12 +68,12 @@ public function writels(string $message)
 
 
     /**
-     * Выводит прогреc бар вида: [наименование процесса] ....         50%
+     * Выводит прогресс бар вида: [наименование процесса] ....  50%
      * ---
      *
      * @param int $percent Численное значение процента выполнения процесса [от 0 до 100], иные значения будут приведены
      * к ближайшему пределу (110->100, -20 -> 0) значения отличных от INT типов вызовут исключение
-     * @param string|null $name Наименование процесса для прогессбара, в случае если требуется его отобразить в именно
+     * @param string|null $name Наименование процесса для ProgressBar в случае если требуется его отобразить в именно
      * в строке прогресс бара, в противном случае параметр указывать нет необходимости, он будет заменен на пустую строку.
      * Либо можно поставить вместо наименования отступ (пустой или форматированный)
      * @param int|null $totalLengthStringProgressBar Общая итоговая длина прогресс бара в символах (не обязателен)

src/Console/Base/Terminal.php

@@ -89,7 +89,7 @@ function readFromProcess($command)
      * Кодовая страница:
      *
      *  Элемент массив [0] содержит все сообщение целиком (String)
-     *  Элементы массива [1],[2], [3], [4] и [5] содержат перечисленные ниже заголовка сообщения параметры
+     *  Элементы массива [1], [2], [3], [4] и [5] содержат перечисленные ниже заголовка сообщения параметры
      *  соответственно. (String) в пределах данного метода преобразование типов не выполняется.
      */
     private static function getConsoleMode(): ?array

src/Contracts/Main/Application.php

@@ -2,6 +2,8 @@
 
 namespace Stub\Framework\Contracts\Main;
 
+use Stub\Framework\Main\MainConfig;
+
 /**
  * Интерфейс приложения
  */
@@ -22,6 +24,22 @@ public function version(): string;
      */
     public function basePath(string $path = ''): string;
 
+    /**
+     * Пpинимает настройки конфигурации текущего выполнения
+     *
+     * @param MainConfig $param
+     * @return void
+     */
+    public function setConfig(MainConfig $param);
+
+    /**
+     * Возвращает настройки конфигурации текущего выполнения
+     * с использованием общего интерфейса редактирования конфигурации
+     *
+     * @return UserEditable
+     */
+    public function getConfig(): UserEditable;
+
     /**
      * Возвращает установленную локаль.
      *

src/Contracts/Main/UserEditable.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Stub\Framework\Contracts\Main;
+
+interface UserEditable
+{
+    /**
+     * Возвращает набор локализаций настроенный в конфигурации
+     * для отображения на странице
+     *
+     * @return array
+     */
+    public static function getLanguageSet(): array;
+
+    /**
+     * Возвращает внутреннее наименованиие директории языкового набора назначенного по умолчанию
+     * значение может быть пустым, в этом случае языковой ресурс по умолчанию будет назначен дефолтный
+     * из коробки.
+     * @return string
+     */
+    public static function getDefaultLanguage(): string;
+
+    /**
+     * Возвращает значение режима автоматического определения языка браузера пользователя
+     * Если этот режим выключить, система не будет определять предпочтительный язык браузера и назначать соответствующий
+     * языковой ресурс при отсутствии явных указаний в URI на конкретный язык локализации. В этом случае будет назначен
+     * язык по умолчанию или (если он не назначен) будет назначен общий основной языковой ресурс находящийся вне
+     * локализаций
+     * @return bool
+     */
+    public static function IsAutomaticDetectionBrowserLanguageEnabled(): bool;
+
+    /**
+     * Возвращает значение режима принудительного отключения возможности выбора языка отображения
+     * Данный режим только сигнализирует о том, элемент интерфейса отвечающий за возможность выбора
+     * языка будет отключен (в базовом шаблоне). Грубо говоря это признак того, что пользователю не должно
+     * быть выдано право выбора языка по желанию.
+     * Однако данный признак не исключает работу логики программы на предмет автоматического определения языка
+     * отображения на основе настроек языка браузера.
+     * @return bool
+     */
+    public static function IsLanguageSelectorDisabled(): bool;
+
+    /**
+     * Возвращает значение режима принудительного отключения локализации ресурса совсем.
+     * Т.е. система не будет определять автоматически предпочтительный язык браузера, даже если флаг этого режима
+     * установлен как истина (включен), система не будет пытаться назначить и назначать языковой ресурс даже если
+     * будет передан параметр языкового ресурса через URI. В реализации базового шаблона заглушки, также будет скрыт
+     * селектор выбора языка локализации ресурса.
+     * В любом случае будет назначен строковый ресурс указанный в настройках как Язык по умолчанию, а в случае
+     * отсутствия этого значения, языковой ресурс будет назначен основной (без локализации, который находится вне
+     * языковых директорий в директории Values)
+     * @return bool
+     */
+    public static function IsResourceLocaleDisabled(): bool;
+}

src/Http/View/Stub.php

@@ -12,6 +12,7 @@
 class Stub implements View
 {
 
+    private $app;
     private $docType;
     private $head;
     private $body;
@@ -29,21 +30,23 @@ class Stub implements View
     public function __construct(Application $app, BaseDefaultStubResource $r)
     {
         $this->stringResources = $r;
-        $this->generate($app);
+        $this->app = $app;
+        $this->generate();
     }
 
     /**
      * Выполняется генерация наполнения основных блоков HTML документа заглушки
-     * @param Application $app
      * @return void
      */
-    private function generate(Application $app)
+    private function generate()
     {
         /**
          * Технический комментарий
-         * @var \Stub\Framework\Main\Assets\BaseDefaultStubResource $r
+         * @var BaseDefaultStubResource $r
          */
+        $app = $this->app;
         $r = $this->stringResources;
+        $c = $app->getConfig();
         $this->docType = "<!DOCTYPE html>";
         $this->head = /** @lang text */
             "
@@ -57,15 +60,21 @@ private function generate(Application $app)
                     <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,600,600i,700,700i|Raleway:300,300i,400,400i,600,600i,700,700i">
                 
                     <!-- Favicons -->
-                    <link href="img/favicon.png" rel="icon">
-                    <link href="img/apple-touch-icon.png" rel="apple-touch-icon">
+                    <link href="/img/favicon.png" rel="icon">
+                    <link href="/img/apple-touch-icon.png" rel="apple-touch-icon">
                 
                     <!-- Vendor CSS Files -->
-                    <link href="vendor/twbs/bootstrap/dist/css/bootstrap.min.css" rel="stylesheet">
-                    <link href="vendor/simplerest/icofont/icofont.min.css" rel="stylesheet">
+                    <link href="/vendor/twbs/bootstrap/dist/css/bootstrap.min.css" rel="stylesheet">
+                    <link href="/vendor/simplerest/icofont/icofont.min.css" rel="stylesheet">
+                    
+                    <!-- Flag-icons-->
+                    <link
+  rel="stylesheet"
+  href="https://cdn.jsdelivr.net/gh/lipis/flag-icons@6.14.0/css/flag-icons.min.css"
+/>
                 
                     <!-- Template Main CSS File -->
-                    <link href="css/main.css" rel="stylesheet">
+                    <link href="/css/main.css" rel="stylesheet">
                 ';
 
         $this->body = /** @lang text */
@@ -78,10 +87,13 @@ private function generate(Application $app)
                                     <a href="index.php">
                                         <span>' . $r::$domain . ' </span>
                                     </a>
-                                </h1>
+                                </h1>                                
                             </div>
+                            
                             <div class="contact-link float-right">
-                                <a href="#contacts" class="scrollto">' . $r::$contacts_link_text . '</a>
+                            ' . (($c::IsLanguageSelectorDisabled()) ? "" : $this->putLanguageSelector($r::$lang, $c::getLanguageSet())) . '
+                                                                               
+                                <a href="#contacts" class="scrollto"><span class="fi fi-' . $r::$lang . '"></span> ' . $r::$contacts_link_text . '</a>
                             </div>
                         </div>
                     </header>
@@ -90,7 +102,7 @@ private function generate(Application $app)
                     <div class="container-fluid" style="padding-right: 0; padding-left: 0;">
                     <!-- ======= Base Stub Section ======= -->
                     <section id="stub"
-                             style="background-image: url(\'img/' . $r::$base_background . '\')">
+                             style="background-image: url(\'/img/' . $r::$base_background . '\')">
                         <div class="stub-container">
                             <BR><BR>
                             <h1>' . $r::$base_title . "</h1>
@@ -164,7 +176,7 @@ private function generate(Application $app)
                     </footer><!-- End #footer -->
                 ';
         $this->endHtmlScripts = /** @lang text */
-            '<script src="js/main.js"></script>';
+            '<script src="/js/main.js"></script>';
     }
 
     /**
@@ -181,4 +193,26 @@ public function getDocumentResult(): string
             $this->body,
             $this->endHtmlScripts);
     }
+
+    private function putLanguageSelector(string $languageCode, array $c = array()): string
+    {
+        $tpl = "";
+        if (empty($c)) {
+            $tpl .= '';
+        } elseif (count($c) == 1) {
+            $tpl .= strtoupper(key($c));
+        } else {
+            $tpl .= '<a><select onchange="window.location.href = this.options[this.selectedIndex].value">';
+            foreach ($c as $key => $item) {
+                $tpl .= '<option value="/' . strtolower($key) . '"';
+                if (strtolower($key) == strtolower($languageCode)) {
+                    $tpl .= 'selected="selected"';
+                }
+                $tpl .= '>' . $item . '</option>';
+            }
+            $tpl .= ' </select></a>';
+        }
+
+        return $tpl;
+    }
 }

src/Main/Application.php

@@ -3,6 +3,7 @@
 namespace Stub\Framework\Main;
 
 use Stub\Framework\Contracts\Main\Application as BaseApplicationContract;
+use Stub\Framework\Contracts\Main\UserEditable;
 
 /**
  * Основной класс приложения (единый для консоли, http  rest APi
@@ -15,7 +16,7 @@ class Application implements BaseApplicationContract
      *
      * @var string
      */
-    const VERSION = '0.1.2';
+    const VERSION = '0.1.3';
 
     /**
      * The base path for the SimpleStub installation.
@@ -31,6 +32,12 @@ class Application implements BaseApplicationContract
      */
     protected $namespace;
 
+    /**
+     * The application configuration object.
+     *
+     * @var string
+     */
+    private $config;
 
     /**
      * Конструктор экземпляра класса приложения
@@ -78,4 +85,14 @@ public function getNamespace(): string
     {
         return __NAMESPACE__;
     }
+
+    public function setConfig(MainConfig $param)
+    {
+        $this->config = $param;
+    }
+
+    public function getConfig():UserEditable
+    {
+        return $this->config;
+    }
 }

src/Main/Assets/BaseDefaultStubResource.php

@@ -60,7 +60,7 @@ abstract class BaseDefaultStubResource implements ContainingResources
      * ----
      * Значение строки содержащее ключевые слова отражающие содержание страницы, в виде строки в которой
      * ключевые слова или фразы перечислены через запятую.
-     * ####<i>!!!Может учитываться поисковыми системами при определении соответствия страницы поисковым запросам!!!</i>
+     * ####<i>!!! Может учитываться поисковыми системами при определении соответствия страницы поисковым запросам!!!</i>
      * @var string
      */
     public static $domain = "SimpleStub";
@@ -190,5 +190,5 @@ abstract class BaseDefaultStubResource implements ContainingResources
      * Код языка по ISO 639-1 (двухбуквенный) содержимого страницы
      * @var string
      */
-    public static $lang = "en";
+    public static $lang = "";
 }

src/Main/Http/Kernel.php

@@ -4,8 +4,10 @@
 
 use DateTime;
 use Stub\Framework\Contracts\Main\Application;
+use Stub\Framework\Contracts\Main\UserEditable;
 use Stub\Framework\Http\View\Stub;
 use Stub\Framework\Main\Assets\BaseDefaultStubResource;
+use Stub\Framework\Main\MainConfig;
 
 /**
  * Класс ядра НТТР
@@ -18,6 +20,8 @@ class Kernel implements \Stub\Framework\Contracts\Http\Kernel
      */
     protected $app;
 
+    private $config;
+
     /**
      * Дата и время старта обрабатываемого запроса
      * @var DateTime|Null
@@ -76,4 +80,15 @@ public function terminate($request = null, $response = null)
         $this->app->terminate();
         exit($response);
     }
+
+    public function setConfig(MainConfig $param)
+    {
+        $this->config = $param;
+        $this->app->setConfig($param);
+    }
+
+    public function getConfig(): UserEditable
+    {
+        return $this->app->getConfig();
+    }
 }