Contracts example

README.md

@@ -21,4 +21,5 @@ Interfaces in this bundle are not intended to be implemented by third-party deve
 - [Resolver Service Usage](doc/02_Resolver_Service_Usage.md)
 - [Event Proxy Service Usage (deprecated)](doc/03_Event_Proxy_Service_Usage.md)
 - [Interceptor Proxy Service Usage](doc/03_Interceptor_Proxy_Service_Usage.md)
-- [Proxy Service Usage](doc/04_Proxy_Service_Usage.md)
+- [Proxy Service Usage](doc/04_Proxy_Service_Usage.md)
+- [Upgrade Notes](doc/02_Upgrade_Notes/README.md)

doc/02_Upgrade_Notes/README.md

@@ -0,0 +1,4 @@
+# Upgrade notes
+
+## 2.0.0
+All Resolver classes and interfaces will be marked as `@internal`

docker-compose.yml

@@ -1,4 +1,3 @@
-version: '3.0'
 services:
     php-static-resolver-bundle:
         image: pimcore/pimcore:php8.2-debug-dev

src/Db/Contracts/DbResolverContract.php

@@ -0,0 +1,43 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Commercial License (PCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     GPLv3 and PCL
+ */
+
+namespace Pimcore\Bundle\StaticResolverBundle\Db\Contracts;
+
+use Doctrine\DBAL\Connection;
+use Pimcore\Db;
+
+class DbResolverContract implements DbResolverContractInterface
+{
+    public function getConnection(): Connection
+    {
+        return Db::getConnection();
+    }
+
+    public function reset(): Connection
+    {
+        return Db::reset();
+    }
+
+    public function get(): Connection
+    {
+        return Db::get();
+    }
+
+    public function close(): void
+    {
+        Db::close();
+    }
+}

src/Db/Contracts/DbResolverContractInterface.php

@@ -0,0 +1,30 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Commercial License (PCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     GPLv3 and PCL
+ */
+
+namespace Pimcore\Bundle\StaticResolverBundle\Db\Contracts;
+
+use Doctrine\DBAL\Connection;
+
+interface DbResolverContractInterface
+{
+    public function getConnection(): Connection;
+
+    public function reset(): Connection;
+
+    public function get(): Connection;
+
+    public function close(): void;
+}

src/Db/DbResolver.php

@@ -16,28 +16,10 @@
 
 namespace Pimcore\Bundle\StaticResolverBundle\Db;
 
-use Doctrine\DBAL\Connection;
-use Pimcore\Db;
+use Pimcore\Bundle\StaticResolverBundle\Db\Contracts\DbResolverContract;
 
-class DbResolver implements DbResolverInterface
+// @internal
+final class DbResolver extends DbResolverContract implements DbResolverInterface
 {
-    public function getConnection(): Connection
-    {
-        return Db::getConnection();
-    }
-
-    public function reset(): Connection
-    {
-        return Db::reset();
-    }
-
-    public function get(): Connection
-    {
-        return Db::get();
-    }
-
-    public function close(): void
-    {
-        Db::close();
-    }
+    //Add new methods here
 }

src/Db/DbResolverInterface.php

@@ -16,15 +16,10 @@
 
 namespace Pimcore\Bundle\StaticResolverBundle\Db;
 
-use Doctrine\DBAL\Connection;
+use Pimcore\Bundle\StaticResolverBundle\Db\Contracts\DbResolverContractInterface;
 
-interface DbResolverInterface
+// @internal
+interface DbResolverInterface extends DbResolverContractInterface
 {
-    public function getConnection(): Connection;
-
-    public function reset(): Connection;
-
-    public function get(): Connection;
-
-    public function close(): void;
+    //Add new methods here
 }

src/Lib/Cache/RuntimeCacheResolver.php

@@ -18,6 +18,9 @@
 
 use Pimcore\Cache\RuntimeCache;
 
+/**
+ * @internal
+ */
 final class RuntimeCacheResolver implements RuntimeCacheResolverInterface
 {
     public function load(string $id): mixed

src/Lib/Cache/RuntimeCacheResolverInterface.php

@@ -16,6 +16,9 @@
 
 namespace Pimcore\Bundle\StaticResolverBundle\Lib\Cache;
 
+/**
+ * @internal
+ */
 interface RuntimeCacheResolverInterface
 {
     public function load(string $id): mixed;

src/Lib/CacheResolver.php

@@ -19,6 +19,9 @@
 use DateInterval;
 use Pimcore\Cache;
 
+/**
+ * @internal
+ */
 final class CacheResolver implements CacheResolverInterface
 {
     public function save(

src/Lib/CacheResolverInterface.php

@@ -18,6 +18,9 @@
 
 use DateInterval;
 
+/**
+ * @internal
+ */
 interface CacheResolverInterface
 {
     public function save(

src/Lib/ConfigResolverInterface.php

@@ -18,6 +18,9 @@
 
 use Exception;
 
+/**
+ * @internal
+ */
 interface ConfigResolverInterface
 {
     public function locateConfigFile(string $name): string;

src/Lib/DocumentResolverInterface.php

@@ -19,6 +19,9 @@
 use Exception;
 use Pimcore\Document\Adapter;
 
+/**
+ * @internal
+ */
 interface DocumentResolverInterface
 {
     /**

src/Lib/Helper/MailResolver.php

@@ -21,6 +21,9 @@
 use Pimcore\Mail;
 use Pimcore\Model\Document;
 
+/**
+ * @internal
+ */
 final class MailResolver implements MailResolverInterface
 {
     /**

src/Lib/Helper/MailResolverInterface.php

@@ -20,6 +20,9 @@
 use Pimcore\Mail;
 use Pimcore\Model\Document;
 
+/**
+ * @internal
+ */
 interface MailResolverInterface
 {
     /**

src/Lib/PimcoreResolver.php

@@ -18,6 +18,9 @@
 
 use Pimcore;
 
+/**
+ * @internal
+ */
 final class PimcoreResolver implements PimcoreResolverInterface
 {
     public function inDevMode(): bool

src/Lib/PimcoreResolverInterface.php

@@ -16,6 +16,9 @@
 
 namespace Pimcore\Bundle\StaticResolverBundle\Lib;
 
+/**
+ * @internal
+ */
 interface PimcoreResolverInterface
 {
     public function inDevMode(): bool;

src/Lib/ToolResolver.php

@@ -20,6 +20,9 @@
 use Pimcore\Mail;
 use Pimcore\Tool;
 
+/**
+ * @internal
+ */
 final class ToolResolver implements ToolResolverInterface
 {
     public function getValidLanguages(): array

src/Lib/ToolResolverInterface.php

@@ -19,6 +19,9 @@
 use Exception;
 use Pimcore\Mail;
 
+/**
+ * @internal
+ */
 interface ToolResolverInterface
 {
     public function getValidLanguages(): array;

src/Lib/Tools/AdminResolverInterface.php

@@ -18,6 +18,9 @@
 
 use Pimcore\Model\User;
 
+/**
+ * @internal
+ */
 interface AdminResolverInterface
 {
     public function reorderWebsiteLanguages(

src/Lib/Tools/Authentication/AuthenticationResolver.php

@@ -20,6 +20,9 @@
 use Pimcore\Tool\Authentication;
 use Symfony\Component\HttpFoundation\Request;
 
+/**
+ * @internal
+ */
 final class AuthenticationResolver implements AuthenticationResolverInterface
 {
     public function authenticateSession(Request $request = null): ?User

src/Lib/Tools/Authentication/AuthenticationResolverInterface.php

@@ -19,6 +19,9 @@
 use Pimcore\Model\User;
 use Symfony\Component\HttpFoundation\Request;
 
+/**
+ * @internal
+ */
 interface AuthenticationResolverInterface
 {
     public function authenticateSession(Request $request = null): ?User;

src/Lib/VideoResolver.php

@@ -20,6 +20,9 @@
 use Pimcore\Video;
 use Pimcore\Video\Adapter;
 
+/**
+ * @internal
+ */
 final class VideoResolver implements VideoResolverInterface
 {
     /**

src/Lib/VideoResolverInterface.php

@@ -19,6 +19,9 @@
 use Exception;
 use Pimcore\Video\Adapter;
 
+/**
+ * @internal
+ */
 interface VideoResolverInterface
 {
     /**

src/Models/Asset/AssetResolverInterface.php

@@ -19,6 +19,9 @@
 use Pimcore\Model\Asset;
 use Pimcore\Model\Asset\Listing;
 
+/**
+ * @internal
+ */
 interface AssetResolverInterface
 {
     public function getById(int|string $id, array $params = []): ?Asset;

src/Models/Asset/AssetServiceResolverInterface.php

@@ -19,6 +19,9 @@
 use Pimcore\Model\Asset;
 use Pimcore\Model\Asset\Folder;
 
+/**
+ * @internal
+ */
 interface AssetServiceResolverInterface
 {
     public function rewriteIds(Asset $asset, array $rewriteConfig): Asset;

src/Models/Asset/Image/Thumbnail/ConfigResolverInterface.php

@@ -19,6 +19,9 @@
 use Exception;
 use Pimcore\Model\Asset\Image\Thumbnail\Config;
 
+/**
+ * @internal
+ */
 interface ConfigResolverInterface
 {
     /**

src/Models/Asset/Video/Thumbnail/ConfigResolverInterface.php

@@ -19,6 +19,9 @@
 use Exception;
 use Pimcore\Model\Asset\Video\Thumbnail\Config;
 
+/**
+ * @internal
+ */
 interface ConfigResolverInterface
 {
     /**

src/Models/DataObject/ClassDefinitionResolver.php

@@ -19,7 +19,10 @@
 use Exception;
 use Pimcore\Model\DataObject\ClassDefinition;
 
-class ClassDefinitionResolver implements ClassDefinitionResolverInterface
+/**
+ * @internal
+ */
+final class ClassDefinitionResolver implements ClassDefinitionResolverInterface
 {
     /**
      * @throws Exception

src/Models/DataObject/ClassDefinitionResolverInterface.php

@@ -19,6 +19,9 @@
 use Exception;
 use Pimcore\Model\DataObject\ClassDefinition;
 
+/**
+ * @internal
+ */
 interface ClassDefinitionResolverInterface
 {
     /**

src/Models/DataObject/ClassificationStore/DefinitionCacheResolverInterface.php

@@ -19,6 +19,9 @@
 use Pimcore\Model\DataObject\Classificationstore\GroupConfig;
 use Pimcore\Model\DataObject\Classificationstore\KeyConfig;
 
+/**
+ * @internal
+ */
 interface DefinitionCacheResolverInterface
 {
     public function get(

src/Models/DataObject/ClassificationStore/GroupConfigResolverInterface.php

@@ -19,6 +19,9 @@
 use Exception;
 use Pimcore\Model\DataObject\Classificationstore\GroupConfig;
 
+/**
+ * @internal
+ */
 interface GroupConfigResolverInterface
 {
     public function getById(int $id, ?bool $force = false): ?GroupConfig;