. */ declare(strict_types=1); namespace Fisharebest\Webtrees\Module; use Aura\Router\RouterContainer; use Fisharebest\Webtrees\Contracts\UserInterface; use Fisharebest\Webtrees\Registry; use Fisharebest\Webtrees\GedcomRecord; use Fisharebest\Webtrees\I18N; use Fisharebest\Webtrees\Submitter; use Fisharebest\Webtrees\Tree; use Fisharebest\Webtrees\Auth; use Illuminate\Database\Capsule\Manager as DB; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; use function app; use function assert; use function redirect; /** * Class SubmitterListModule */ class SubmitterListModule extends AbstractModule implements ModuleListInterface, RequestHandlerInterface { use ModuleListTrait; protected const ROUTE_URL = '/tree/{tree}/submitter-list'; /** @var int The default access level for this module. It can be changed in the control panel. */ protected $access_level = Auth::PRIV_NONE; /** * Initialization. * * @return void */ public function boot(): void { $router_container = app(RouterContainer::class); assert($router_container instanceof RouterContainer); $router_container->getMap() ->get(static::class, static::ROUTE_URL, $this); } /** * How should this module be identified in the control panel, etc.? * * @return string */ public function title(): string { /* I18N: Name of a module/list */ return I18N::translate('Submitters'); } /** * A sentence describing what this module does. * * @return string */ public function description(): string { /* I18N: Description of the “Shared submitters” module */ return I18N::translate('A list of submitters.'); } /** * Should this module be enabled when it is first installed? * * @return bool */ public function isEnabledByDefault(): bool { return false; } /** * CSS class for the URL. * * @return string */ public function listMenuClass(): string { return 'menu-list-subm'; } /** * @param Tree $tree * @param mixed[] $parameters * * @return string */ public function listUrl(Tree $tree, array $parameters = []): string { $parameters['tree'] = $tree->name(); return route(static::class, $parameters); } /** * @return array */ public function listUrlAttributes(): array { return []; } /** * @param Tree $tree * * @return bool */ public function listIsEmpty(Tree $tree): bool { return !DB::table('other') ->where('o_file', '=', $tree->id()) ->where('o_type', '=', Submitter::RECORD_TYPE) ->exists(); } /** * Handle URLs generated by older versions of webtrees * * @param ServerRequestInterface $request * * @return ResponseInterface */ public function getListAction(ServerRequestInterface $request): ResponseInterface { return redirect($this->listUrl($request->getAttribute('tree'), $request->getQueryParams())); } /** * @param ServerRequestInterface $request * * @return ResponseInterface */ public function handle(ServerRequestInterface $request): ResponseInterface { $tree = $request->getAttribute('tree'); assert($tree instanceof Tree); $user = $request->getAttribute('user'); assert($user instanceof UserInterface); Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user); $submitters = DB::table('other') ->where('o_file', '=', $tree->id()) ->where('o_type', '=', Submitter::RECORD_TYPE) ->get() ->map(Registry::submitterFactory()->mapper($tree)) ->filter(GedcomRecord::accessFilter()); return $this->viewResponse('modules/submitter-list/page', [ 'submitters' => $submitters, 'title' => I18N::translate('Submitters'), 'tree' => $tree, ]); } }