Add abstract class Provider as base class for SyncProvider

Author: lkrms

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/Sync/Concept/SyncProvider.php

@@ -2,13 +2,12 @@
 
 namespace Lkrms\Sync\Concept;
 
-use Lkrms\Container\Container;
+use Lkrms\Concept\Provider;
+use Lkrms\Contract\IContainer;
 use Lkrms\Contract\IPipeline;
 use Lkrms\Contract\IService;
-use Lkrms\Support\DateFormatter;
 use Lkrms\Support\Pipeline;
 use Lkrms\Sync\Contract\ISyncContext;
-use Lkrms\Sync\Contract\ISyncDefinition;
 use Lkrms\Sync\Contract\ISyncEntity;
 use Lkrms\Sync\Contract\ISyncProvider;
 use Lkrms\Sync\Support\SyncContext;
@@ -24,16 +23,8 @@
  * Base class for providers that sync entities to and from third-party backends
  *
  */
-abstract class SyncProvider implements ISyncProvider, IService
+abstract class SyncProvider extends Provider implements ISyncProvider, IService
 {
-    /**
-     * Get a DateFormatter to work with the backend's date format and timezone
-     *
-     * The {@see DateFormatter} returned by this method is cached for the
-     * lifetime of the {@see SyncProvider} instance.
-     */
-    abstract protected function getDateFormatter(): DateFormatter;
-
     /**
      * Get a dependency subtitution map for the class
      *
@@ -59,24 +50,6 @@ public static function getContextualBindings(): array
         return [];
     }
 
-    /**
-     * @inheritDoc
-     */
-    public function description(): ?string
-    {
-        return null;
-    }
-
-    /**
-     * @var Container
-     */
-    protected $App;
-
-    /**
-     * @var Env
-     */
-    protected $Env;
-
     /**
      * @var SyncStore
      */
@@ -87,20 +60,14 @@ public function description(): ?string
      */
     private $Id;
 
-    /**
-     * @var DateFormatter|null
-     */
-    private $DateFormatter;
-
     /**
      * @var array<string,Closure>
      */
     private $MagicMethodClosures = [];
 
-    public function __construct(Container $app, Env $environment, SyncStore $store)
+    public function __construct(IContainer $app, Env $env, SyncStore $store)
     {
-        $this->App = $app;
-        $this->Env = $environment;
+        parent::__construct($app, $env);
         $this->Store = $store;
 
         $this->Store->provider($this);
@@ -113,21 +80,6 @@ final public function setProviderId(int $providerId)
         return $this;
     }
 
-    final public function app(): Container
-    {
-        return $this->App;
-    }
-
-    final public function container(): Container
-    {
-        return $this->App;
-    }
-
-    final public function env(): Env
-    {
-        return $this->Env;
-    }
-
     final public function store(): SyncStore
     {
         return $this->Store;
@@ -156,15 +108,6 @@ final protected function buildSerializeRules(string $entity): SerializeRulesBuil
             ->entity($entity);
     }
 
-    /**
-     * @inheritDoc
-     */
-    final public function dateFormatter(): DateFormatter
-    {
-        return $this->DateFormatter
-            ?? ($this->DateFormatter = $this->getDateFormatter());
-    }
-
     final public static function getServices(): array
     {
         return SyncIntrospector::get(static::class)->getSyncProviderInterfaces();