Merge pull request #109 from koriym/doc-bindings

koriym · web-flow · commit 38cee0d8025c · 2022-03-26T15:27:10.000+09:00
Document the bindings provided by modules
diff --git a/src/CacheVersionModule.php b/src/CacheVersionModule.php
@@ -7,6 +7,13 @@
 use Ray\Di\AbstractModule;
 use Ray\PsrCacheModule\CacheNamespaceModule;
 
+/**
+ * Provides CacheNamespace and derived bindings
+ *
+ * The following module is installed:
+ *
+ * -CacheNamespaceModule
+ */
 final class CacheVersionModule extends AbstractModule
 {
     /** @var string */
diff --git a/src/CacheableModule.php b/src/CacheableModule.php
@@ -12,6 +12,16 @@
 use BEAR\Sunday\Extension\Transfer\HttpCacheInterface;
 use Ray\Di\AbstractModule;
 
+/**
+ *  Provides HttpCacheInterface and derived bindings
+ *
+ *  The following bindings are provided:
+ *
+ *  HttpCacheInterface
+ *  -Commands
+ *  RefreshInterceptor
+ *  StorageExpiryModule
+ */
 final class CacheableModule extends AbstractModule
 {
     /**
diff --git a/src/DevEtagModule.php b/src/DevEtagModule.php
@@ -6,6 +6,13 @@
 
 use Ray\Di\AbstractModule;
 
+/**
+ * Provides EtagSetterInterface and derived bindings
+ *
+ * The following module is installed:
+ *
+ * EtagSetterInterface
+ */
 final class DevEtagModule extends AbstractModule
 {
     /**
diff --git a/src/DonutCacheModule.php b/src/DonutCacheModule.php
@@ -10,6 +10,25 @@
 use Ray\Di\AbstractModule;
 use Ray\Di\Scope;
 
+/**
+ * Provides ResourceStorageInterface and derived bindings
+ *
+ * The following bindings are provided:
+ *
+ * HeaderSetter
+ * CdnCacheControlHeaderSetterInterface
+ * DonutRepositoryInterface
+ * RepositoryLoggerInterface
+ * PurgerInterface
+ * UriTagInterface
+ *
+ * The following interceptors are provided:
+ *
+ * DonutCacheableResponseInterceptor
+ * DonutCacheInterceptor
+ * DonutCommandInterceptor
+ * DonutCacheInterceptor
+ */
 final class DonutCacheModule extends AbstractModule
 {
     /**
diff --git a/src/MobileEtagModule.php b/src/MobileEtagModule.php
@@ -7,6 +7,13 @@
 use Ray\Di\AbstractModule;
 use Ray\Di\Scope;
 
+/**
+ * Provides EtagSetterInterface
+ *
+ * The following bindings are provided:
+ *
+ * EtagSetterInterface
+ */
 final class MobileEtagModule extends AbstractModule
 {
     /**
diff --git a/src/QueryRepositoryModule.php b/src/QueryRepositoryModule.php
@@ -13,6 +13,27 @@
 use Ray\PsrCacheModule\Annotation\Shared;
 use Symfony\Component\Cache\Adapter\NullAdapter;
 
+/**
+ *  Provides ResourceStorageInterface and derived bindings
+ *
+ *  The following bindings are provided:
+ *
+ *  CacheItemPoolInterface-Shared::class
+ *  CacheItemPoolInterface-EtagPool::class
+ *  QueryRepositoryInterface
+ *  CacheDependencyInterface
+ *  EtagSetterInterface
+ *  NamedParameterInterface
+ *  ResourceStorageInterface
+ *  MatchQueryInterface
+ *  UriTag
+ *  MatchQueryInterface
+ *
+ *  The following module are installed.
+ *
+ *  CacheableModule
+ *  DonutCacheModule
+ */
 final class QueryRepositoryModule extends AbstractModule
 {
     /**
diff --git a/src/StorageRedisModule.php b/src/StorageRedisModule.php
@@ -12,6 +12,17 @@
 use Ray\PsrCacheModule\Psr6RedisModule;
 use Symfony\Component\Cache\Adapter\RedisAdapter;
 
+/**
+ * Provides ResourceStorageInterface and derived bindings
+ *
+ * The following bindings are provided:
+ *
+ * CacheItemPoolInterface-EtagPool::class
+ *
+ * The following module are installed:
+ *
+ * Psr6RedisModule
+ */
 final class StorageRedisModule extends AbstractModule
 {
     /** @var string */
