Merge branch 'sync'

Author: lkrms

phpstan-baseline.neon

@@ -55,16 +55,6 @@ parameters:
 			count: 1
 			path: src/Concept/Facade.php
 
-		-
-			message: "#^Method Lkrms\\\\Contract\\\\IExtensible\\:\\:getMetaProperty\\(\\) has no return type specified\\.$#"
-			count: 1
-			path: src/Contract/IExtensible.php
-
-		-
-			message: "#^Method Lkrms\\\\Contract\\\\IExtensible\\:\\:setMetaProperty\\(\\) has parameter \\$value with no type specified\\.$#"
-			count: 1
-			path: src/Contract/IExtensible.php
-
 		-
 			message: "#^Method Lkrms\\\\Contract\\\\IPipe\\:\\:handle\\(\\) has parameter \\$pipeline with generic interface Lkrms\\\\Contract\\\\IPipeline but does not specify its types\\: TInput, TOutput, TArgument$#"
 			count: 1
@@ -485,11 +475,6 @@ parameters:
 			count: 1
 			path: src/Sync/Contract/ISyncEntityProvider.php
 
-		-
-			message: "#^Method Lkrms\\\\Sync\\\\Contract\\\\ISyncProvider\\:\\:getDefinition\\(\\) return type with generic interface Lkrms\\\\Sync\\\\Contract\\\\ISyncDefinition does not specify its types\\: TEntity, TProvider$#"
-			count: 1
-			path: src/Sync/Contract/ISyncProvider.php
-
 		-
 			message: "#^Method Lkrms\\\\Sync\\\\Support\\\\SyncContext\\:\\:maybeApplyFilterPolicy\\(\\) has parameter \\$empty with no type specified\\.$#"
 			count: 1

src/Concept/Provider.php

@@ -0,0 +1,93 @@
+<?php declare(strict_types=1);
+
+namespace Lkrms\Concept;
+
+use Lkrms\Contract\IContainer;
+use Lkrms\Contract\IProvider;
+use Lkrms\Exception\MethodNotImplementedException;
+use Lkrms\Support\DateFormatter;
+use Lkrms\Utility\Env;
+
+/**
+ * Base class for providers
+ *
+ */
+abstract class Provider implements IProvider
+{
+    protected IContainer $App;
+
+    protected Env $Env;
+
+    private DateFormatter $DateFormatter;
+
+    /**
+     * Creates a new provider object
+     */
+    public function __construct(IContainer $app, Env $env)
+    {
+        $this->App = $app;
+        $this->Env = $env;
+    }
+
+    /**
+     * Get a DateFormatter to work with the backend's date format and/or
+     * timezone
+     *
+     * The {@see DateFormatter} returned will be cached for the lifetime of the
+     * {@see Provider} instance.
+     */
+    abstract protected function getDateFormatter(): DateFormatter;
+
+    /**
+     * @inheritDoc
+     */
+    public function description(): ?string
+    {
+        return null;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function checkHeartbeat(int $ttl = 300)
+    {
+        throw new MethodNotImplementedException(
+            static::class,
+            __FUNCTION__,
+            IProvider::class
+        );
+    }
+
+    /**
+     * @inheritDoc
+     */
+    final public function app(): IContainer
+    {
+        return $this->App;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    final public function container(): IContainer
+    {
+        return $this->App;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    final public function env(): Env
+    {
+        return $this->Env;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    final public function dateFormatter(): DateFormatter
+    {
+        return $this->DateFormatter
+            ?? ($this->DateFormatter = $this->getDateFormatter());
+    }
+}

src/Concern/HasNormaliser.php

@@ -0,0 +1,35 @@
+<?php declare(strict_types=1);
+
+namespace Lkrms\Concern;
+
+use Lkrms\Contract\ReturnsNormaliser;
+use Lkrms\Utility\Convert;
+use Closure;
+
+/**
+ * Implements ReturnsNormaliser
+ *
+ * @see ReturnsNormaliser
+ */
+trait HasNormaliser
+{
+    /**
+     * @var array<string,Closure(string $name, bool $greedy=, string...$hints): string>
+     */
+    private static $_Normaliser = [];
+
+    public static function normaliser(): Closure
+    {
+        return
+            fn(string $name): string =>
+                Convert::toSnakeCase($name);
+    }
+
+    final public static function normalise(string $name, bool $greedy = true, string ...$hints): string
+    {
+        $normaliser = self::$_Normaliser[static::class]
+            ?? (self::$_Normaliser[static::class] = static::normaliser());
+
+        return $normaliser($name, $greedy, ...$hints);
+    }
+}

src/Concern/TConstructible.php

@@ -51,18 +51,17 @@ final public static function construct(array $data, ?IContainer $container = nul
      *
      * See {@see TConstructible::construct()} for more information.
      *
-     * @param iterable<mixed[]> $dataList
-     * @param int $conformity One of the {@see ArrayKeyConformity} values. Use
-     * `COMPLETE` or `PARTIAL` wherever possible to improve performance.
-     * @phpstan-param ArrayKeyConformity::* $conformity
+     * @param iterable<mixed[]> $list
+     * @param ArrayKeyConformity::* $conformity Use `COMPLETE` or `PARTIAL`
+     *  wherever possible to improve performance.
      * @param IContainer|null $container Used to create each instance if set.
      * @param (IHierarchy&static)|null $parent If the class implements
      * {@see IHierarchy}, pass `$parent` to each instance via
      * {@see IHierarchy::setParent()}.
      * @return Generator<static>
      */
     final public static function constructList(
-        iterable $dataList,
+        iterable $list,
         int $conformity = ArrayKeyConformity::NONE,
         ?IContainer $container = null,
         $parent = null
@@ -72,7 +71,7 @@ final public static function constructList(
         }
 
         $closure = null;
-        foreach ($dataList as $key => $data) {
+        foreach ($list as $key => $data) {
             if (!$closure) {
                 /** @var Introspector<static,IntrospectionClass<static>> */
                 $builder = Introspector::getService($container, static::class);

src/Concern/TIntrospector.php

@@ -24,7 +24,7 @@ trait TIntrospector
     /**
      * @var array<string,TIntrospectionClass>
      */
-    private static $IntrospectionClasses = [];
+    private static $_IntrospectionClasses = [];
 
     /**
      * @param class-string<TClass> $class
@@ -73,8 +73,8 @@ private function __construct(string $class)
     {
         $_class = strtolower($class);
         $this->_Class =
-            (self::$IntrospectionClasses[$_class] ?? null)
-                ?: (self::$IntrospectionClasses[$_class] =
+            (self::$_IntrospectionClasses[$_class] ?? null)
+                ?: (self::$_IntrospectionClasses[$_class] =
                     $this->getIntrospectionClass($class));
     }
 }