phpcs implementation

Author: Asisyas

phpcs.xml

@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset name="pcsg-generated-ruleset">
+    <file>src/</file>
+    <arg name="basepath" value="."/>
+    <arg name="colors"/>
+    <arg name="no-cache"/>
+    <description>
+        Micro Framework -  сode formatting rules.
+    </description>
+    <rule ref="Generic.CodeAnalysis.EmptyStatement"/>
+    <rule ref="Generic.CodeAnalysis.JumbledIncrementer"/>
+    <rule ref="Generic.CodeAnalysis.UnconditionalIfStatement"/>
+    <rule ref="Generic.CodeAnalysis.UnnecessaryFinalModifier"/>
+    <rule ref="Generic.CodeAnalysis.UselessOverridingMethod"/>
+    <rule ref="Generic.ControlStructures.InlineControlStructure"/>
+    <rule ref="Generic.Files.ByteOrderMark"/>
+    <rule ref="Generic.Files.LineEndings"/>
+    <rule ref="Generic.Files.LineLength">
+        <properties>
+            <property name="lineLimit" value="120"/>
+            <property name="absoluteLineLimit" value="140"/>
+        </properties>
+    </rule>
+    <rule ref="Generic.Formatting.DisallowMultipleStatements"/>
+    <rule ref="Generic.Formatting.MultipleStatementAlignment"/>
+    <rule ref="Generic.Formatting.NoSpaceAfterCast"/>
+    <rule ref="Generic.Functions.CallTimePassByReference"/>
+    <rule ref="Generic.Functions.OpeningFunctionBraceBsdAllman"/>
+    <rule ref="Generic.Metrics.CyclomaticComplexity"/>
+    <rule ref="Generic.Metrics.NestingLevel"/>
+    <rule ref="Generic.NamingConventions.ConstructorName"/>
+    <rule ref="Generic.NamingConventions.UpperCaseConstantName"/>
+    <rule ref="Generic.NamingConventions.CamelCapsFunctionName"/>
+    <rule ref="Generic.PHP.DeprecatedFunctions"/>
+    <rule ref="Generic.PHP.DisallowShortOpenTag"/>
+    <rule ref="Generic.PHP.ForbiddenFunctions"/>
+    <rule ref="Generic.PHP.LowerCaseConstant"/>
+    <rule ref="Generic.PHP.NoSilencedErrors"/>
+    <rule ref="Generic.Strings.UnnecessaryStringConcat"/>
+    <rule ref="Generic.WhiteSpace.DisallowTabIndent"/>
+    <rule ref="MySource.PHP.EvalObjectFactory"/>
+    <rule ref="MySource.PHP.GetRequestData"/>
+    <rule ref="PEAR.Classes.ClassDeclaration"/>
+    <rule ref="PEAR.Commenting.InlineComment"/>
+    <rule ref="PEAR.ControlStructures.MultiLineCondition"/>
+    <rule ref="PEAR.Files.IncludingFile"/>
+    <rule ref="PEAR.Formatting.MultiLineAssignment"/>
+    <rule ref="PEAR.Functions.ValidDefaultValue"/>
+    <rule ref="PEAR.NamingConventions.ValidClassName"/>
+    <rule ref="PEAR.WhiteSpace.ObjectOperatorIndent"/>
+    <rule ref="PEAR.WhiteSpace.ScopeClosingBrace"/>
+    <rule ref="PEAR.WhiteSpace.ScopeIndent"/>
+    <rule ref="PSR1.Classes.ClassDeclaration"/>
+    <rule ref="PSR1.Files.SideEffects"/>
+    <rule ref="PSR2.Classes.ClassDeclaration"/>
+    <rule ref="PSR2.Classes.PropertyDeclaration"/>
+    <rule ref="PSR2.ControlStructures.ControlStructureSpacing"/>
+    <rule ref="PSR2.ControlStructures.ElseIfDeclaration"/>
+    <rule ref="PSR2.ControlStructures.SwitchDeclaration"/>
+    <rule ref="PSR2.Files.EndFileNewline"/>
+    <rule ref="PSR2.Methods.MethodDeclaration"/>
+    <rule ref="PSR2.Namespaces.NamespaceDeclaration"/>
+    <rule ref="PSR2.Namespaces.UseDeclaration"/>
+</ruleset>

src/Configuration/ApplicationConfigurationInterface.php

@@ -5,9 +5,10 @@
 interface ApplicationConfigurationInterface
 {
     /**
-     * @param  string $key
-     * @param  $default
+     * @param string $key
+     * @param $default
+     * @param bool $nullable
      * @return mixed
      */
-    public function get(string $key, $default = null): mixed;
+    public function get(string $key, $default = null, bool $nullable = true): mixed;
 }

src/Configuration/DefaultApplicationConfiguration.php

@@ -2,8 +2,14 @@
 
 namespace Micro\Framework\Kernel\Configuration;
 
+use Micro\Framework\Kernel\Configuration\Exception\InvalidConfigurationException;
+
 class DefaultApplicationConfiguration implements ApplicationConfigurationInterface
 {
+    private const BOOLEAN_TRUE = [
+        'true', 'on', '1', 'yes'
+    ];
+
     /**
      * @param array<string, mixed> $configuration
      */
@@ -14,7 +20,44 @@ public function __construct(private array $configuration)
     /**
      * {@inheritDoc}
      */
-    public function get(string $key, $default = null): mixed
+    public function get(string $key, $default = null, bool $nullable = true): mixed
+    {
+        if(is_bool($default)) {
+            return $this->getBooleanValue($key, $default);
+        }
+
+        $value = $this->getValue($key, $default);
+
+        if($nullable === false && !$value) {
+            throw new InvalidConfigurationException(sprintf('Configuration key "%s" can not be NULL', $key));
+        }
+
+        return $value;
+    }
+
+    /**
+     * @param string $key
+     * @param bool $default
+     *
+     * @return bool
+     */
+    protected function getBooleanValue(string $key, bool $default): bool
+    {
+        $value = $this->getValue($key, $default);
+        if($value === null) {
+            return $default;
+        }
+
+        return in_array(mb_strtolower($value), self::BOOLEAN_TRUE, true);
+    }
+
+    /**
+     * @param string $key
+     * @param mixed $default
+     *
+     * @return mixed
+     */
+    protected function getValue(string $key, mixed $default): mixed
     {
         return $this->configuration[$key] ?? $default;
     }

src/Configuration/PluginRoutingKeyConfiguration.php

@@ -10,8 +10,9 @@ class PluginRoutingKeyConfiguration extends PluginConfiguration
      */
     public function __construct(
         ApplicationConfigurationInterface $configuration,
-        protected string $configRoutingKey
-    ) {
+    protected string $configRoutingKey
+    )
+    {
         parent::__construct($configuration);
     }
 
@@ -25,16 +26,17 @@ protected function cfg(string $key): string
     }
 
     /**
-     * @param  string $key
-     * @param  $default
+     * @param string $key
+     * @param $default
+     * @param bool $nullable
      * @return mixed
      */
-    protected function get(string $key, $default = null): mixed
+    protected function get(string $key, $default = null, bool $nullable = true): mixed
     {
         return $this->configuration->get(
             $this->cfg($key),
-            $default
+            $default,
+            $nullable
         );
     }
 }
-

src/Configuration/Resolver/PluginConfigurationClassResolver.php

@@ -2,7 +2,6 @@
 
 namespace Micro\Framework\Kernel\Configuration\Resolver;
 
-
 use Micro\Framework\Kernel\Configuration\ApplicationConfigurationInterface;
 use Micro\Framework\Kernel\Configuration\PluginConfiguration;
 
@@ -20,7 +19,8 @@ class PluginConfigurationClassResolver
     public function __construct(
     private string $pluginClass,
     private ApplicationConfigurationInterface $applicationConfiguration
-    ) {
+    )
+    {
         $this->resolvers = $this->getPluginClassResolvers();
     }
 
@@ -30,7 +30,7 @@ public function __construct(
     public function resolve(): PluginConfiguration
     {
         $configClassDefault = PluginConfiguration::class;
-        $configClasses = [];
+        $configClasses      = [];
 
         foreach ($this->resolvers as $resolver) {
             $configClass = $resolver->resolve($this->pluginClass);

src/Kernel.php

@@ -2,8 +2,6 @@
 
 namespace Micro\Framework\Kernel;
 
-
-
 use Micro\Component\DependencyInjection\Container;
 use Micro\Framework\Kernel\Configuration\ApplicationConfigurationInterface;
 use Micro\Framework\Kernel\Configuration\PluginConfiguration;
@@ -39,8 +37,9 @@ public function __construct(
     private ApplicationConfigurationInterface $configuration,
     private array $pluginBootLoaderCollection,
     private ?Container $container = null
-    ) {
-        $this->isStarted = false;
+    )
+    {
+        $this->isStarted    = false;
         $this->isTerminated = false;
 
         $this->plugins = [];

src/KernelBuilder.php

@@ -33,7 +33,7 @@ class KernelBuilder
 
     public function __construct()
     {
-        $this->pluginCollection = [];
+        $this->pluginCollection           = [];
         $this->bootLoaderPluginCollection = [];
     }