summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGreg Roach <fisharebest@webtrees.net>2019-03-04 12:30:04 +0000
committerGreg Roach <fisharebest@webtrees.net>2019-03-04 12:30:22 +0000
commit786e5f36299f8d8f04785e145e537138736c6fa0 (patch)
tree06a6261d48f1e6931d649b91e52430cf47a3ac1c
parentc7ae637d968c48f4699fe2200c826b31fc3ed8d2 (diff)
downloadwebtrees-786e5f36299f8d8f04785e145e537138736c6fa0.tar.gz
webtrees-786e5f36299f8d8f04785e145e537138736c6fa0.tar.bz2
webtrees-786e5f36299f8d8f04785e145e537138736c6fa0.zip
Update module README
-rw-r--r--modules_v4/README.md22
1 files changed, 11 insertions, 11 deletions
diff --git a/modules_v4/README.md b/modules_v4/README.md
index dbe74ccc28..7fc774a0b1 100644
--- a/modules_v4/README.md
+++ b/modules_v4/README.md
@@ -152,6 +152,7 @@ use Fisharebest\Webtrees\Module\AbstractModule;
use Fisharebest\Webtrees\Module\ModuleCustomInterface;
use Fisharebest\Webtrees\Module\ModuleCustomTrait;
use Fisharebest\Webtrees\Services\TimeoutService;
+use Fisharebest\Webtrees\Tree;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
@@ -162,34 +163,33 @@ return new class extends AbstractModule implements ModuleCustomInterface {
use ModuleCustomTrait;
/** @var TimeoutService */
- private $timeout_service;
+ protected $timeout_service;
/**
- * This module needs the timeout service.
+ * IMPORTANT - the constructor is called for *all* modules, even ones
+ * that are disabled. You should do little more than initialise your
+ * private/protected members.
*
* @param TimeoutService $timeout_service
*/
public function __construct(TimeoutService $timeout_service)
{
- $this->timeout_service = $timeout_service;
-
- // You can replace core webtrees classes by providing alternate implementations:
- app()->bind('name of webtrees class', 'name of replacement class');
- app()->bind('name of webtrees class', new \stdClass());
+ $this->timeout_service = $timeout_service;
}
/**
* Methods that are called in response to HTTP requests use
* dependency-injection. You'll almost certainly need the request
- * object. The restrictions on the constructor do not apply here.
+ * object.
*
- * @param Request $request
+ * @param Request $request
+ * @param Tree|null $tree
*
* @return Response
*/
- public function getFooBarAction(Request $request): Response
+ public function getFooBarAction(Request $request, ?Tree $tree): Response
{
- return new Response($request->get('foo'));
+ return new Response();
}
};
```