. */ declare(strict_types=1); namespace Fisharebest\Webtrees\Module; use Aura\Router\RouterContainer; use Fisharebest\Webtrees\Auth; use Fisharebest\Webtrees\GedcomRecord; use Fisharebest\Webtrees\I18N; use Fisharebest\Webtrees\Location; use Fisharebest\Webtrees\Registry; use Fisharebest\Webtrees\Tree; use Fisharebest\Webtrees\Validator; 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 LocationListModule */ class LocationListModule extends AbstractModule implements ModuleListInterface, RequestHandlerInterface { use ModuleListTrait; protected const ROUTE_URL = '/tree/{tree}/location-list'; /** @var int The default access level for this module. It can be changed in the control panel. */ protected int $access_level = Auth::PRIV_USER; /** * 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('Locations'); } /** * A sentence describing what this module does. * * @return string */ public function description(): string { /* I18N: Description of the “Locations” module */ return I18N::translate('A list of locations.'); } /** * CSS class for the URL. * * @return string */ public function listMenuClass(): string { return 'menu-list-loc'; } /** * @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', '=', Location::RECORD_TYPE) ->exists(); } /** * Handle URLs generated by older versions of webtrees * * @param ServerRequestInterface $request * * @return ResponseInterface */ public function getListAction(ServerRequestInterface $request): ResponseInterface { $tree = Validator::attributes($request)->tree(); return redirect($this->listUrl($tree, $request->getQueryParams())); } /** * @param Tree $tree * @param array|null> $parameters * * @return string */ public function listUrl(Tree $tree, array $parameters = []): string { $parameters['tree'] = $tree->name(); return route(static::class, $parameters); } /** * @param ServerRequestInterface $request * * @return ResponseInterface */ public function handle(ServerRequestInterface $request): ResponseInterface { $tree = Validator::attributes($request)->tree(); $user = Validator::attributes($request)->user(); Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user); $locations = DB::table('other') ->where('o_file', '=', $tree->id()) ->where('o_type', '=', Location::RECORD_TYPE) ->get() ->map(Registry::locationFactory()->mapper($tree)) ->filter(GedcomRecord::accessFilter()); return $this->viewResponse('modules/location-list/page', [ 'locations' => $locations, 'title' => I18N::translate('Locations'), 'tree' => $tree, ]); } }