diff options
| author | Greg Roach <fisharebest@webtrees.net> | 2019-11-13 14:34:49 +0000 |
|---|---|---|
| committer | Greg Roach <fisharebest@webtrees.net> | 2019-11-13 14:34:49 +0000 |
| commit | b8fc901f205cd6af65496b916bf63547a3065a2f (patch) | |
| tree | a1f20cbc7eb94802a0540daed2e71d7fa205caf7 /modules_v4 | |
| parent | b38a7b8536afc6d4d8213bbfd13d324e68a1e851 (diff) | |
| download | webtrees-b8fc901f205cd6af65496b916bf63547a3065a2f.tar.gz webtrees-b8fc901f205cd6af65496b916bf63547a3065a2f.tar.bz2 webtrees-b8fc901f205cd6af65496b916bf63547a3065a2f.zip | |
Module README
Diffstat (limited to 'modules_v4')
| -rw-r--r-- | modules_v4/README.md | 31 |
1 files changed, 18 insertions, 13 deletions
diff --git a/modules_v4/README.md b/modules_v4/README.md index 45955c639e..6e70f9581e 100644 --- a/modules_v4/README.md +++ b/modules_v4/README.md @@ -125,7 +125,7 @@ return new class extends PedigreeChartModule implements ModuleCustomInterface { } // Change the default layout... - public const DEFAULT_ORIENTATION = self::STYLE_DOWN; + public const DEFAULT_ORIENTATION = parent::STYLE_DOWN; }; ``` @@ -146,11 +146,10 @@ created until after the modules. * the current tree `Tree` or objects that depend on it (`Statistics`) as these objects are not created until after the module is created. -Instead, the user, tree and locale can be obtained from the request object. e.g. +Instead, these objects can be obtained from the request object. e.g. ```php -$tree = $request->getAttribute('tree'); -$user = $request->getAttribute('user'); -$locale = $request->getAttribute('locale'); +$tree = $request->getAttribute('tree'); +$user = $request->getAttribute('user'); ``` ```php @@ -159,9 +158,8 @@ 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; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; /** * Creating an anoymous class will prevent conflicts with other custom modules. @@ -189,14 +187,21 @@ return new class extends AbstractModule implements ModuleCustomInterface { * dependency-injection. You'll almost certainly need the request * object. * - * @param Request $request - * @param Tree|null $tree + * @param ServerRequestInterface $request * - * @return Response + * @return ResponseInterface */ - public function getFooBarAction(Request $request, ?Tree $tree): Response + public function getFooBarAction(ServerRequestInterface $request): ResponseInterface { - return new Response(); + // This assumes that there is a tree parameter in the URL. + $tree = $request->getAttribute('tree'); + + // This will be a User (or a GuestUser for visitors). + $user = $request->getAttribute('user'); + + $html = $tree->name() . '/' . $user->realName(); + + return response($html); } }; ``` |
