From e060cc882fbe012d6c0c56dc3ef480c26aaffa2c Mon Sep 17 00:00:00 2001 From: Akihito Koriyama Date: Mon, 28 Mar 2022 08:33:57 +0900 Subject: [PATCH] Document the public bindings provided by modules --- src/Module/SundayModule.php | 3 +++ src/Provide/Router/RouterModule.php | 8 ++++++++ src/Provide/Transfer/HttpCacheModule.php | 3 +++ src/Provide/Transfer/HttpResponderModule.php | 9 +++++++++ 4 files changed, 23 insertions(+) diff --git a/src/Module/SundayModule.php b/src/Module/SundayModule.php index 85d2f856..e331329e 100644 --- a/src/Module/SundayModule.php +++ b/src/Module/SundayModule.php @@ -11,6 +11,9 @@ use BEAR\Sunday\Provide\Transfer\HttpResponderModule; use Ray\Di\AbstractModule; +/** + * Provides BEAR.Sunday base bindings + */ class SundayModule extends AbstractModule { protected function configure(): void diff --git a/src/Provide/Router/RouterModule.php b/src/Provide/Router/RouterModule.php index 4194c666..731a935c 100644 --- a/src/Provide/Router/RouterModule.php +++ b/src/Provide/Router/RouterModule.php @@ -8,6 +8,14 @@ use BEAR\Sunday\Extension\Router\RouterInterface; use Ray\Di\AbstractModule; +/** + * Provides RouterInterface and derived bindings + * + * The following bindings are provided: + * + * RouterInterface + * -DefaultSchemeHost + */ class RouterModule extends AbstractModule { protected function configure(): void diff --git a/src/Provide/Transfer/HttpCacheModule.php b/src/Provide/Transfer/HttpCacheModule.php index 766c0686..34220c36 100644 --- a/src/Provide/Transfer/HttpCacheModule.php +++ b/src/Provide/Transfer/HttpCacheModule.php @@ -8,6 +8,9 @@ use BEAR\Sunday\Extension\Transfer\NullHttpCache; use Ray\Di\AbstractModule; +/** + * Provides HttpCacheInterface bindings + */ class HttpCacheModule extends AbstractModule { protected function configure(): void diff --git a/src/Provide/Transfer/HttpResponderModule.php b/src/Provide/Transfer/HttpResponderModule.php index a1d6a361..144d1e25 100644 --- a/src/Provide/Transfer/HttpResponderModule.php +++ b/src/Provide/Transfer/HttpResponderModule.php @@ -7,6 +7,15 @@ use BEAR\Sunday\Extension\Transfer\TransferInterface; use Ray\Di\AbstractModule; +/** + * Provides TransferInterface and derived bindings + * + * The following bindings are provided: + * + * TransferInterface + * HeaderInterface + * ConditionalResponseInterface + */ class HttpResponderModule extends AbstractModule { protected function configure(): void